package
27.5.1+incompatible
Repository: https://github.com/docker/cli.git
Documentation: pkg.go.dev

# Functions

CapabilitiesMap normalizes the given capabilities and converts them to a map.
ConvertKVStringsToMap converts ["key=value"] to {"key":"value"}.
ConvertKVStringsToMapWithNil converts ["key=value"] to {"key":"value"} but set unset keys to nil - meaning the ones with no "=" in them.
ConvertPortToPortConfig converts ports to the swarm type.
EffectiveCapAddCapDrop normalizes and sorts capabilities to "add" and "drop", and returns the effective capabilities to include in both.
NewDurationOpt creates a DurationOpt with the specified duration.
NewFilterOpt returns a new FilterOpt.
NewListOpts creates a new ListOpts with the specified validator.
NewListOptsRef creates a new ListOpts with the specified values and validator.
NewMapOpts creates a new MapOpts with the specified map of values and a validator.
NewNamedListOptsRef creates a reference to a new NamedListOpts struct.
NewNamedMapOpts creates a reference to a new NamedMapOpts struct.
NewQuotedString returns a new quoted string option.
NewThrottledeviceOpt creates a new ThrottledeviceOpt.
NewUlimitOpt creates a new UlimitOpt.
NewWeightdeviceOpt creates a new WeightdeviceOpt.
NormalizeCapability normalizes a capability by upper-casing, trimming white space and adding a CAP_ prefix (if not yet present).
ParseCPUs takes a string ratio and returns an integer value of nano cpus.
ParseEnvFile reads a file with environment variables enumerated by lines “Environment variable names used by the utilities in the Shell and Utilities volume of IEEE Std 1003.1-2001 consist solely of uppercase letters, digits, and the '_' (underscore) from the characters defined in Portable Character Set and do not begin with a digit.
ParseHost and set defaults for a Daemon host string.
ParseLink parses and validates the specified string as a link format (name:alias).
ParseRestartPolicy returns the parsed policy or an error indicating what is incorrect.
ParseTCPAddr parses and validates that the specified address is a valid TCP address.
ReadKVEnvStrings reads a file of line terminated key=value pairs, and overrides any keys present in the file with additional pairs specified in the override parameter.
ReadKVStrings reads a file of line terminated key=value pairs, and overrides any keys present in the file with additional pairs specified in the override parameter.
ValidateDNSSearch validates domain for resolvconf search configuration.
ValidateEnv validates an environment variable and returns it.
ValidateExtraHost validates that the specified string is a valid extrahost and returns it.
ValidateHost validates that the specified string is a valid host and returns it.
ValidateIPAddress validates if the given value is a correctly formatted IP address, and returns the value in normalized form.
ValidateLabel validates that the specified string is a valid label, and returns it.
ValidateLink validates that the specified string has a valid link format (containerName:alias).
ValidateMACAddress validates a MAC address.
ValidateSysctl validates a sysctl and returns it.
ValidateThrottleBpsDevice validates that the specified string has a valid device-rate format.
ValidateThrottleIOpsDevice validates that the specified string has a valid device-rate format.
ValidateWeightDevice validates that the specified string has a valid device-weight format.

# Constants

AllCapabilities is a special value to add or drop all capabilities.
ResetCapabilities is a special value to reset capabilities when updating.

# Structs

ConfigOpt is a Value type for parsing configs.
DurationOpt is an option type for time.Duration that uses a pointer.
FilterOpt is a flag type for validating filters.
GpuOpts is a Value type for parsing mounts.
ListOpts holds a list of values and a validation function.
MapOpts holds a map of values and a validation function.
MountOpt is a Value type for parsing mounts.
NamedListOpts is a ListOpts with a configuration name.
NamedMapOpts is a MapOpts struct with a configuration name.
NetworkAttachmentOpts represents the network options for endpoint creation.
NetworkOpt represents a network config in swarm mode.
PortOpt represents a port config in swarm mode.
PositiveDurationOpt is an option type for time.Duration that uses a pointer.
QuotedString is a string that may have extra quotes around the value.
SecretOpt is a Value type for parsing secrets.
ThrottledeviceOpt defines a map of ThrottleDevices.
UlimitOpt defines a map of Ulimits.
WeightdeviceOpt defines a map of WeightDevices.

# Interfaces

NamedOption is an interface that list and map options with names implement.

# Type aliases

MemBytes is a type for human readable memory bytes (like 128M, 2g, etc).
MemSwapBytes is a type for human readable memory bytes (like 128M, 2g, etc).
NanoCPUs is a type for fixed point fractional number.
ValidatorFctListType defines a validator function that returns a validated list of string and/or an error.
ValidatorFctType defines a validator function that returns a validated string and/or an error.
ValidatorThrottleFctType defines a validator function that returns a validated struct and/or an error.
ValidatorWeightFctType defines a validator function that returns a validated struct and/or an error.