# Functions
Attach attaches to a running container.
Checkpoint checkpoints the given container (identified by nameOrID).
Commit creates a container image from a container.
ContainerInit takes a created container and executes all of the preparations to run the container except it will not start or attach to the container.
No description provided by the author
CopyFromArchiveWithOptions copy files into container.
CopyToArchive copy files from container.
No description provided by the author
DemuxFrame reads contents for frame from server multiplexed stdin/stdout/stderr/2nd error channel.
DemuxHeader reads header for stream from server multiplexed stdin/stdout/stderr/2nd error channel.
Diff provides the changes between two container layers.
ExecCreate creates a new exec session in an existing container.
ExecInspect inspects an existing exec session, returning detailed information about it.
ExecStart starts (but does not attach to) a given exec session.
ExecStartAndAttach starts and attaches to a given exec session.
Exists is a quick, light-weight way to determine if a given container exists in local storage.
Export creates a tarball of the given name or ID of a container.
GetMountedContainerPaths returns a map of mounted containers and their mount locations.
Inspect returns low level information about a Container.
Kill sends a given signal to a given container.
List obtains a list of containers in local storage.
Logs obtains a container's logs given the options provided.
Mount mounts an existing container to the filesystem.
Pause pauses a given container.
Prune removes stopped and exited containers from local storage.
Remove removes a container from local storage.
Rename an existing container.
ResizeContainerTTY sets container's TTY height and width in characters.
ResizeExecTTY sets session's TTY height and width in characters.
Restart restarts a running container.
Restore restores a checkpointed container to running.
RunHealthCheck executes the container's healthcheck and returns the health status of the container.
No description provided by the author
Start starts a non-running container.The nameOrID can be a container name or a partial/full ID.
Stat checks if the specified path is on the container.
No description provided by the author
Stop stops a running container.
Top gathers statistics about the running processes in a container.
Unmount unmounts a container from the filesystem.
Unpause resumes the given paused container.
Wait blocks until the given container reaches a condition.
# Variables
No description provided by the author
# Structs
go:generate go run ../generator/generator.go AttachOptions AttachOptions are optional options for attaching to containers.
go:generate go run ../generator/generator.go CheckpointOptions CheckpointOptions are optional options for checkpointing containers.
go:generate go run ../generator/generator.go CommitOptions CommitOptions describe details about the resulting committed image as defined by repo and tag.
go:generate go run ../generator/generator.go CopyOptions CopyOptions are options for copying to containers.
go:generate go run ../generator/generator.go CreateOptions CreateOptions are optional options for creating containers.
go:generate go run ../generator/generator.go DiffOptions DiffOptions are optional options for creating containers.
go:generate go run ../generator/generator.go ExecInspectOptions ExecInspectOptions are optional options for inspecting exec sessions.
go:generate go run ../generator/generator.go ExecStartAndAttachOptions ExecStartAndAttachOptions are optional options for resizing container ExecTTYs.
go:generate go run ../generator/generator.go ExecStartOptions ExecStartOptions are optional options for starting exec sessions.
go:generate go run ../generator/generator.go ExistsOptions ExistsOptions are optional options for checking if a container exists.
go:generate go run ../generator/generator.go ExportOptions ExportOptions are optional options for exporting containers.
go:generate go run ../generator/generator.go HealthCheckOptions HealthCheckOptions are optional options for checking the health of a container.
go:generate go run ../generator/generator.go InitOptions InitOptions are optional options for initing containers.
go:generate go run ../generator/generator.go InspectOptions InspectOptions are optional options for inspecting containers.
go:generate go run ../generator/generator.go KillOptions KillOptions are optional options for killing containers.
go:generate go run ../generator/generator.go ListOptions ListOptions are optional options for listing containers.
go:generate go run ../generator/generator.go LogOptions LogOptions describe finer control of log content or how the content is formatted.
go:generate go run ../generator/generator.go MountedContainerPathsOptions MountedContainerPathsOptions are optional options for getting container mount paths.
go:generate go run ../generator/generator.go MountOptions MountOptions are optional options for mounting containers.
go:generate go run ../generator/generator.go PauseOptions PauseOptions are optional options for pausing containers.
go:generate go run ../generator/generator.go PruneOptions PruneOptions are optional options for pruning containers.
go:generate go run ../generator/generator.go RemoveOptions RemoveOptions are optional options for removing containers.
go:generate go run ../generator/generator.go RenameOptions RenameOptions are options for renaming containers.
go:generate go run ../generator/generator.go ResizeExecTTYOptions ResizeExecTTYOptions are optional options for resizing container ExecTTYs.
go:generate go run ../generator/generator.go ResizeTTYOptions ResizeTTYOptions are optional options for resizing container TTYs.
go:generate go run ../generator/generator.go RestartOptions RestartOptions are optional options for restarting containers.
go:generate go run ../generator/generator.go RestoreOptions RestoreOptions are optional options for restoring containers.
go:generate go run ../generator/generator.go ShouldRestartOptions ShouldRestartOptions.
go:generate go run ../generator/generator.go StartOptions StartOptions are optional options for starting containers.
go:generate go run ../generator/generator.go StatsOptions StatsOptions are optional options for getting stats on containers.
go:generate go run ../generator/generator.go StopOptions StopOptions are optional options for stopping containers.
go:generate go run ../generator/generator.go TopOptions TopOptions are optional options for getting running processes in containers.
go:generate go run ../generator/generator.go UnmountOptions UnmountOptions are optional options for unmounting containers.
go:generate go run ../generator/generator.go UnpauseOptions UnpauseOptions are optional options for unpausing containers.
go:generate go run ../generator/generator.go WaitOptions WaitOptions are optional options for waiting on containers.
# Interfaces
The CloseWriter interface is used to determine whether we can do a one-sided close of a hijacked connection.