types

package

Go to main page

Versions in this module

v0

v0.5.0

May 12, 2026

v0.4.0

Apr 29, 2026

v0.3.0

Apr 10, 2026

Changes in this version

type ContainerOps

+ ContainerPause func(ctx context.Context, id string, opts *ContainerPauseOptions) error

+ ContainerRestart func(ctx context.Context, id string, opts *ContainerRestartOptions) error

+ ContainerUnpause func(ctx context.Context, id string, opts *ContainerUnpauseOptions) error

+ type ContainerPauseOptions struct

+ type ContainerRestartOptions struct

+ Signal string

+ Timeout *int

+ type ContainerUnpauseOptions struct

type EventAction

+ const EventActionPull

v0.2.0

Mar 28, 2026

Changes in this version

+ type CPUStats struct

+ UsageNano uint64

+ UsedPercent float64

type ContainerCreateConfig

+ Cmd []string

+ Entrypoint []string

+ Privileged bool

+ User string

type ContainerCreateResult

+ ID string

type ContainerExecOptions

+ Stderr io.Writer

+ Stdout io.Writer

+ TTY bool

type ContainerLogsOptions

+ Stderr io.Writer

+ Stdout io.Writer

+ type ContainerStats struct

+ CPU CPUStats

+ ID string

+ Memory MemoryStats

+ Name string

+ OperatingSystem string

+ ReadTime time.Time

+ type ContainerStatsOptions struct

+ Stream bool

+ type ContainerStatsResult struct

+ Errors <-chan error

+ Stats <-chan ContainerStats

type ContainerWaitResult

+ ExitCode int64

type ImagePullOptions

+ Progress chan<- ImagePullProgress

+ type ImagePullProgress struct

+ Current int64

+ Digest string

+ ID string

+ Status string

+ Total int64

+ type MemoryStats struct

+ LimitMb uint64

+ MaxUsedMb uint64

+ UsedMb uint64

+ UsedPercent float64

+ type TelemetryOps interface

+ ContainerStats func(ctx context.Context, id string, opts *ContainerStatsOptions) (ContainerStatsResult, error)

v0.1.0

Mar 22, 2026

Changes in this version

+ var ErrConflict = errors.New("container state conflict")

+ var ErrConnectionFailed = errors.New("connection failed")

+ var ErrContainerNotFound = errors.New("container not found")

+ var ErrImageNotFound = errors.New("image not found")

+ var ErrInternal = errors.New("internal error")

+ var ErrInvalidInput = errors.New("invalid input")

+ var ErrNotFound = errors.New("not found")

+ var ErrPermissionsDenied = errors.New("permission denied")

+ var ErrUnauthorized = errors.New("unauthorized")

+ type AuthConfig struct

+ IdentityToken string

+ Password string

+ RegistryToken string

+ ServerAddress string

+ Username string

+ type ContainerCreateConfig struct

+ CPUs float64

+ Env map[string]string

+ Image string

+ Labels map[string]string

+ MemoryMb int64

+ Mounts []Mount

+ Name string

+ Ports []PortBinding

+ Restart RestartPolicy

+ type ContainerCreateResult string

+ type ContainerExecOptions struct

+ AttachStderr bool

+ AttachStdout bool

+ Cmd []string

+ Env []string

+ User string

+ WorkingDir string

+ func (opts *ContainerExecOptions) Validate() error

+ type ContainerExecResult struct

+ ExitCode int64

+ Stderr string

+ Stdout string

+ type ContainerListOptions struct

+ All bool

+ Filters Filters

+ type ContainerListResult struct

+ Containers []ContainerSummary

+ type ContainerLogsOptions struct

+ Details bool

+ Follow bool

+ ShowStderr bool

+ ShowStdout bool

+ Since time.Time

+ Tail string

+ Timestamps bool

+ Until time.Time

+ type ContainerLogsResult io.ReadCloser

+ type ContainerOps interface

+ ContainerCreate func(ctx context.Context, cfg *ContainerCreateConfig) (ContainerCreateResult, error)

+ ContainerExec func(ctx context.Context, id string, opts *ContainerExecOptions) (ContainerExecResult, error)

+ ContainerList func(ctx context.Context, opts *ContainerListOptions) (ContainerListResult, error)

+ ContainerLogs func(ctx context.Context, id string, opts *ContainerLogsOptions) (ContainerLogsResult, error)

+ ContainerRemove func(ctx context.Context, id string, opts *ContainerRemoveOptions) error

+ ContainerStart func(ctx context.Context, id string, opts *ContainerStartOptions) error

+ ContainerStatus func(ctx context.Context, id string, opts *ContainerStatusOptions) (ContainerStatusResult, error)

+ ContainerStop func(ctx context.Context, id string, opts *ContainerStopOptions) error

+ ContainerWait func(ctx context.Context, id string, opts *ContainerWaitOptions) (ContainerWaitResult, error)

+ type ContainerRemoveOptions struct

+ Force bool

+ RemoveVolumes bool

+ type ContainerStartOptions struct

+ type ContainerStatusOptions struct

+ Size bool

+ type ContainerStatusResult struct

+ ExitCode int

+ ID string

+ IPAddress string

+ Status string

+ type ContainerStopOptions struct

+ Signal string

+ Timeout *int

+ type ContainerSummary struct

+ Created time.Time

+ ID string

+ Image string

+ Labels map[string]string

+ Names []string

+ State string

+ Status string

+ type ContainerWaitOptions struct

+ Condition WaitCondition

+ type ContainerWaitResult int64

+ type Event struct

+ Action EventAction

+ Actor EventActor

+ Time time.Time

+ Type EventType

+ type EventAction string

+ const EventActionCreate

+ const EventActionDelete

+ const EventActionDestroy

+ const EventActionDie

+ const EventActionKill

+ const EventActionOOM

+ const EventActionPause

+ const EventActionRemove

+ const EventActionRestart

+ const EventActionStart

+ const EventActionStop

+ const EventActionUnPause

+ type EventActor struct

+ ID string

+ type EventOps interface

+ EventsStream func(ctx context.Context, opts *EventsStreamOptions) EventsStreamResult

+ type EventType string

+ const EventTypeContainer

+ const EventTypeImage

+ const EventTypeNetwork

+ const EventTypeVolume

+ type EventsStreamOptions struct

+ Filters Filters

+ Since time.Time

+ Until time.Time

+ type EventsStreamResult struct

+ Errors <-chan error

+ Events <-chan Event

+ type Filters map[string][]string

+ func (f Filters) Add(key string, values ...string) Filters

+ type ImageInspectOptions struct

+ type ImageInspectResult struct

+ Architecture string

+ Created time.Time

+ ID string

+ OperatingSystem string

+ Size int64

+ Tags []string

+ type ImageListOptions struct

+ All bool

+ Filters Filters

+ type ImageListResult struct

+ Images []ImageSummary

+ type ImageOps interface

+ ImageInspect func(ctx context.Context, id string, opts *ImageInspectOptions) (ImageInspectResult, error)

+ ImageList func(ctx context.Context, opts *ImageListOptions) (ImageListResult, error)

+ ImagePrune func(ctx context.Context, opts *ImagePruneOptions) (ImagePruneResult, error)

+ ImagePull func(ctx context.Context, name string, opts *ImagePullOptions) error

+ ImageRemove func(ctx context.Context, id string, opts *ImageRemoveOptions) (ImageRemoveResult, error)

+ type ImagePruneOptions struct

+ Filters Filters

+ type ImagePruneResult struct

+ ImagesRemoved []ImageRemoveSummary

+ SpaceReclaimed uint64

+ type ImagePullOptions struct

+ All bool

+ type ImageRemoveOptions struct

+ Force bool

+ PruneChildren bool

+ type ImageRemoveResult struct

+ ImagesRemoved []ImageRemoveSummary

+ type ImageRemoveSummary struct

+ Deleted string

+ Untagged string

+ type ImageSummary struct

+ Created time.Time

+ ID string

+ Labels map[string]string

+ Size int64

+ Tags []string

+ type InfoResult struct

+ Architecture string

+ Containers int

+ ContainersPaused int

+ ContainersRunning int

+ ContainersStopped int

+ Driver string

+ ID string

+ Images int

+ KernelVersion string

+ MemTotal int64

+ MemoryLimit bool

+ NCPU int

+ Name string

+ OSType string

+ OSVersion string

+ OperatingSystem string

+ ServerVersion string

+ SwapLimit bool

+ SystemTime time.Time

+ Warnings []string

+ type Mount struct

+ Destination string

+ ReadOnly bool

+ Source string

+ Type string

+ type PortBinding struct

+ ContainerPort int

+ HostIP string

+ HostPort int

+ Protocol string

+ type RestartPolicy string

+ const RestartAlways

+ const RestartDisable

+ const RestartOnFailure

+ const RestartUnlessStopped

+ func (r RestartPolicy) IsValid() bool

+ func (r RestartPolicy) String() string

+ type Runtime interface

+ type SystemOps interface

+ Close func() error

+ Info func(ctx context.Context) (InfoResult, error)

+ Login func(ctx context.Context, auth AuthConfig) error

+ type WaitCondition string

+ const WaitConditionNextExit

+ const WaitConditionNotRunning

+ const WaitConditionRemoved

+ func (w WaitCondition) IsValid() bool

+ func (w WaitCondition) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL