package
0.0.0-20230918061241-7ae29b85948f
Repository: https://github.com/hashicorp/vagrant-plugin-sdk.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

Configure configures c with the provided configuration.
Configure configures c with the provided configuration.
Documentation returns the documentation for the given component.
No description provided by the author
No description provided by the author
Id returns a unique Id that can be used for new values.
ProtoAny returns an *anypb.Any for the given ProtoMarshaler object.
ProtoAny returns []*anypb.Any for the given input slice by encoding each result into a proto value.
ProtoAnyUnmarshal attempts to unmarshal a ProtoMarshler implementation to another type.
UnmarshalOptionsProto transforms a proto containing component options into its equivalent go struct.

# Constants

Authenticator.
Command.
Communicator.
Config.
Downloader.
Bool.
String.
Guest.
Host.
Invalid.
LogPlatform.
LogViewer.
Mapper.
PluginInfo.
Provider.
Provisioner.
Push.
SyncedFolder.

# Variables

DefaultOptions contains default options values for components that use options.
OptionsTypeMap is a mapping of a type to the nil pointer of the interface to the options struct (if any) for that type.
TypeMap is a mapping of Type to the nil pointer to the interface of that type.

# Structs

AuthResult is the return value expected from Authenticator.AuthFunc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
JobInfo is available to plugins to get information about the context in which a job is executing.
LogEvent represents a single log entry.
No description provided by the author
No description provided by the author
ProviderOptions stores options about a given provider plugin which are used in provider selection and validation.
SyncedFolderOptions contains attributes that can be configured for a Synced Folder plugin.

# Interfaces

Authenticator is responsible for authenticating different types of plugins.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Configurable can be optionally implemented by any compontent to accept user configuration.
ConfigurableNotify is an optional interface that can be implemented by any component to receive a notification that the configuration was decoded.
Documented can be optionally implemented by any component to return documentation about the component.
No description provided by the author
No description provided by the author
No description provided by the author
LogPlatform is responsible for reading the logs for a deployment.
LogViewer returns batches of log lines.
No description provided by the author
ProtoMarshaler is the interface required by objects that must support protobuf marshaling.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
Type is an enum of all the types of components supported.