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

# Packages

Package backend includes types to send information to server backends.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
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
No description provided by the author

# Functions

NewHijackedResponse intializes a HijackedResponse type.

# Constants

BuildCacheObject represents a build-cache DiskUsageObject.
BuilderBuildKit is builder based on moby/buildkit project.
BuilderV1 is the first generation builder in docker daemon.
ContainerObject represents a container DiskUsageObject.
Healthy indicates that the container is running correctly.
ImageObject represents an image DiskUsageObject.
MediaTypeMultiplexedStream is vendor specific MIME-Type set for stdin/stdout/stderr multiplexed streams.
MediaTypeRawStream is vendor specific MIME-Type set for raw TTY streams.
Indicates there is no healthcheck.
Values for RegistryAuthFrom in ServiceUpdateOptions.
Values for RegistryAuthFrom in ServiceUpdateOptions.
Starting indicates that the container is not yet ready.
Unhealthy indicates that the container has a problem.
VolumeObject represents a volume DiskUsageObject.

# Structs

BlkioStatEntry is one small entity to store a piece of Blkio stats Not used on Windows.
BlkioStats stores All IO service stats for data read and write.
BuildCache contains information about a build cache record.
BuildCachePruneOptions hold parameters to prune the build cache.
BuildCachePruneReport contains the response for Engine API: POST "/build/prune".
BuildResult contains the image id of a successful build.
ComponentVersion describes the version information for a specific component.
ConfigCreateResponse contains the information returned to a client on the creation of a new config.
ConfigListOptions holds parameters to list configs.
Container contains response of Engine API: GET "/containers/json".
ContainerExecInspect holds information returned by exec inspect.
ContainerJSON is newly used struct along with MountPoint.
ContainerJSONBase contains response of Engine API: GET "/containers/{name:.*}/json".
ContainerNode stores information about the node that a container is running on.
ContainerPathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.
ContainersPruneReport contains the response for Engine API: POST "/containers/prune".
ContainerState stores container's running state it's part of ContainerJSONBase and will return by "inspect" command.
ContainerStats contains response of Engine API: GET "/stats".
CopyConfig contains request body of Engine API: POST "/containers/"+containerID+"/copy".
CopyToContainerOptions holds information about files to copy into a container.
CPUStats aggregates and wraps all CPU related info of container.
CPUUsage stores All CPU stats aggregated since container inception.
DefaultNetworkSettings holds network information during the 2 release deprecation period.
DiskUsage contains response of Engine API: GET "/system/df".
DiskUsageOptions holds parameters for system disk usage query.
EndpointResource contains network resources allocated and used for a container in a network.
ErrorResponse Represents an error.
EventsOptions holds parameters to filter events with.
ExecConfig is a small subset of the Config struct that holds the configuration for the exec feature of docker.
ExecStartCheck is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package.
GraphDriverData Information about the storage driver used to store the container's and image's filesystem.
Health stores information about the container's healthcheck results.
HealthcheckResult stores information about a single run of a healthcheck probe.
HijackedResponse holds connection information for a hijacked request.
IDResponse Response to an API call that returns just an Id swagger:model IdResponse.
ImageBuildOptions holds the information necessary to build images.
ImageBuildOutput defines configuration for exporting a build result.
ImageBuildResponse holds information returned by a server after building an image.
ImageImportSource holds source information for ImageImport.
ImageInspect contains response of Engine API: GET "/images/{name:.*}/json".
ImageLoadResponse returns information to the client about a load process.
ImageSearchOptions holds parameters to search images with.
ImagesPruneReport contains the response for Engine API: POST "/images/prune".
MemoryStats aggregates all memory stats since container inception on Linux.
MountPoint represents a mount point configuration inside the container.
NetworkConnect represents the data to be used to connect a container to the network.
NetworkCreate is the expected body of the "create network" http request message.
NetworkCreateRequest is the request message sent to the server for network create call.
NetworkCreateResponse is the response message sent by the server for network create call.
NetworkDisconnect represents the data to be used to disconnect a container from the network.
NetworkInspectOptions holds parameters to inspect network.
NetworkListOptions holds parameters to filter the list of networks with.
NetworkResource is the body of the "get network" http response message.
NetworkSettings exposes the network settings in the api.
NetworkSettingsBase holds networking state for a container when inspecting it.
NetworksPruneReport contains the response for Engine API: POST "/networks/prune".
NetworkStats aggregates the network stats of one container.
NodeListOptions holds parameters to list nodes with.
NodeRemoveOptions holds parameters to remove nodes with.
PidsStats contains the stats of a container's pids.
Ping contains response of Engine API: GET "/_ping".
Plugin A plugin for the Engine API swagger:model Plugin.
PluginConfig The config of a plugin.
PluginConfigArgs plugin config args swagger:model PluginConfigArgs.
PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface.
PluginConfigLinux plugin config linux swagger:model PluginConfigLinux.
PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork.
PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs.
PluginConfigUser plugin config user swagger:model PluginConfigUser.
PluginCreateOptions hold all options to plugin create.
PluginDevice plugin device swagger:model PluginDevice.
PluginDisableOptions holds parameters to disable plugins.
PluginEnableOptions holds parameters to enable plugins.
PluginEnv plugin env swagger:model PluginEnv.
PluginInstallOptions holds parameters to install a plugin.
PluginInterfaceType plugin interface type swagger:model PluginInterfaceType.
PluginMount plugin mount swagger:model PluginMount.
PluginPrivilege describes a permission the user has to accept upon installing a plugin.
PluginRemoveOptions holds parameters to remove plugins.
PluginSettings Settings that can be modified by users.
Port An open port on a container swagger:model Port.
PushResult contains the tag, manifest digest, and manifest size from the push.
RootFS returns Image's RootFS description including the layer IDs.
SecretCreateResponse contains the information returned to a client on the creation of a new secret.
SecretListOptions holds parameters to list secrets.
ServiceCreateOptions contains the options to use when creating a service.
ServiceInspectOptions holds parameters related to the "service inspect" operation.
ServiceListOptions holds parameters to list services with.
ServiceUpdateOptions contains the options to be used for updating services.
Stats is Ultimate struct aggregating all types of stats of one container.
StatsJSON is newly used Networks.
StorageStats is the disk I/O stats for read/write on Windows.
SummaryNetworkSettings provides a summary of container's networks in /containers/json.
SwarmUnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey.
TaskListOptions holds parameters to list tasks with.
ThrottlingData stores CPU throttling stats of one running container.
Version contains response of Engine API: GET "/version".
VolumesPruneReport contains the response for Engine API: POST "/volumes/prune".

# Interfaces

CloseWriter is an interface that implements structs that close input streams to prevent from writing.

# Type aliases

BuilderVersion sets the version of underlying builder to use.
DiskUsageObject represents an object type used for disk usage query filtering.
ImageCreateOptions holds information to create images.
ImageImportOptions holds information to import images from the client host.
ImageListOptions holds parameters to list images with.
ImagePullOptions holds information to pull images.
ImagePushOptions holds information to push images.
ImageRemoveOptions holds parameters to remove images.
PluginPrivileges is a list of PluginPrivilege.
PluginsListResponse contains the response for the Engine API.
RequestPrivilegeFunc is a function interface that clients can supply to retry operations after getting an authorization error.