# Functions
NewService creates a new Service.
WithAttachDetachKeys sets the key sequence for detaching from an attach request.
WithAttachStdErr enables stderr on an attach request.
WithAttachStdin enables stdin on an attach request.
WithAttachStdOut enables stdout on an attach request.
WithAttachStream sets the stream option on an attach request When attaching, unless you only want historical data (e.g.
WithCreateAttachStderr is a CreateOption which enables attaching to the container's stderr.
WithCreateAttachStdin is a CreateOption which enables attaching to the container's stdin.
WithCreateAttachStdout is a CreateOption which enables attaching to the container's stdout.
WithCreateCmd is a CreateOption which sets the command to run in the container.
WithCreateConfig is a CreateOption which sets the Config for the container create spec.
WithCreateHostConfig is a CreateOption which sets the HostConfig for the container create spec.
WithCreateImage is a CreateOption which sets the container image.
WithCreateName is a CreateOption which sets the container's name.
WithCreateNetworkingConfig is a CreateOption which sets the NetworkConfig for the container create spec.
No description provided by the author
WithCreateAttachStdinOnce is a CreateOption which enables attaching to the container's one time.
WithCreateTTY is a CreateOption which configures the container with a TTY.
WithExecCmd is an ExecOption that sets the command to execute in the container.
WithKillSignal returns a KillOption that sets the signal to send to the container.
WithRemoveForce is a RemoveOption that enables the force remove option.
WithStopTimeout sets the timeout for a stop request.
No description provided by the author
# Constants
DefaultExecDecodeLimitBytes is the default max size that will be read from a container create response.
DefaultInspectDecodeLimitBytes is the default value used for limit how much data is read from the inspect response.
DefaultWaitDecodeLimitBytes is the default max size that will be read from a container wait response.
Possible WaitCondition Values.
Possible WaitCondition Values.
Possible WaitCondition Values.
# Structs
AttachConfig holds the options for attaching to a container.
CommitConfig is used by CommitOption to set options used for committing a container to an image.
CommitImageReference sets the image reference to use when committing an image.
Container provides bindings for interacting with a container in Docker.
CreateConfig holds the options for creating a container.
No description provided by the author
ExecInspect holds detailed information about an exec'd process.
ExecInspectConfig holds all the options for inspecting an exec process.
ExecProcess represents an "Exec"'d process in a container.
ExecProcessConfig holds information about the exec process running on the host.
ExecResizeConfig holds the options for resizing an exec TTY.
ExecStartConfig holds all the options for starting a new process in a container.
InspectConfig holds the options for inspecting a container.
KillConfig holds options available for the kill API.
ListConfig holds the options for listing containers.
ListFilter represents filters to process on the container list.
No description provided by the author
NewConfig holds the options available for `New`.
RemoveConfig holds options for container remove.
Service facilitates all communication with Docker's container endpoints.
Spec holds all the configuration for the container create API request.
StartConfig holds configuration options for container start.
StopConfig holds the options for stopping a container.
WaitConfig holds the options for waiting on a container.
# Interfaces
AttachIO is used to for providing access to stdio streams of a container.
ExitStatus is used to report information about a container exit It is used by container.Wait.
# Type aliases
AttachOption is used as functional arguments to container attach.
CommitOption is used as a funtional option when commiting a container to an an image.
CreateOption is used as functional arguments for creating a container CreateOptions configure a CreateConfig.
ExecInspectOption is used as functional arguments for configuring an ExecInspectConfig.
ExecOption is used as functional arguments to configure an ExecConfig.
ExecStartOption is used as functional arguments to configure an ExecStartConfig.
InspectOption is used as functional arguments to inspect a container InspectOptions configure an InspectConfig.
KillOption is a functional argument passed to `Kill`, it is used to configure a KillConfig.
ListOption is used as functional arguments to list containers ListOption configure a ListConfig.
No description provided by the author
NewOption is used as functional parameters to `New`.
RemoveOption is used as functional arguments for container remove RemoveOptioni configure a RemoveConfig.
StartOption is used as functional arguments for container Start A StartOption configures a StartConfig.
StopOption is used as functional arguments to container stop StopOptions configure a StopConfig.
WaitCondition is a type used to specify a container state for which to wait.
WaitOption is used as functional arguments to container wait WaitOptions configure a WaitConfig.