api

Documentation

Index

• Constants
• Variables
• func DefaultSocketPath() string
• type Name
  • func MustNewName(s string) Name
  • func NewName(s string) (Name, error)
• type Version
  • func MustNewVersion(s string) Version
  • func NewVersion(s string) (Version, error)

Constants

const (
	// PluginLaunchedByEngineVar is used to inform engine-launched plugins about their name.
	PluginLaunchedByEngineVar = "DOCKER_SECRETS_ENGINE_PLUGIN_LAUNCH_CFG"
	// DefaultPluginRegistrationTimeout is the default timeout for plugin registration.
	DefaultPluginRegistrationTimeout = 5 * time.Second
	// DefaultPluginRequestTimeout is the default timeout for plugins to handle a request.
	DefaultPluginRequestTimeout = 2 * time.Second
)

Variables

var (
	ErrEmptyVersion = errors.New("empty version")
	ErrVPrefix      = errors.New("missing version prefix")
)

var ErrEmptyName = errors.New("empty name")

Functions

func DefaultSocketPath

func DefaultSocketPath() string

Types

type Name

type Name interface {
	String() string
}

func MustNewName

func MustNewName(s string) Name

MustNewName creates a new Name as NewName does, but panics when a validation error occurs.

func NewName

func NewName(s string) (Name, error)

NewName creates a new Name from a string If a validation error occurs, it returns nil and the error.

type Version

type Version interface {
	String() string
}

func MustNewVersion

func MustNewVersion(s string) Version

MustNewVersion creates a new Version as NewVersion does, but panics when a validation error occurs.

func NewVersion

func NewVersion(s string) (Version, error)

NewVersion creates a new Version from a string If a validation error occurs, it returns nil and the error.