progress

package

v5.7.0 Latest Latest Go to latest Published: Nov 2, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/compose

Links

Open Source Insights

Documentation ¶

Overview ¶

Package progress builds the progress events Compose reports while it operates on resources.

Index ¶

func Created(id string) api.Resource
func Creating(id string) api.Resource
func Error(id string, msg string) api.Resource
func Exited(id string) api.Resource
func Healthy(id string) api.Resource
func New(id string, status api.EventStatus, text string, reason ...string) api.Resource
func Removed(id string) api.Resource
func Removing(id string) api.Resource
func Skipped(id string, reason string) api.Resource
func Stopped(id string) api.Resource
func Stopping(id string) api.Resource
func Waiting(id string) api.Resource
type Noop

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Created ¶

func Created(id string) api.Resource

Created is the event of a resource that was created.

func Creating ¶

func Creating(id string) api.Resource

Creating is the event of a resource being created.

func Error ¶

func Error(id string, msg string) api.Resource

Error builds the event of a resource whose operation failed.

func Exited ¶

func Exited(id string) api.Resource

Exited is the event of a resource that exited.

func Healthy ¶

func Healthy(id string) api.Resource

Healthy is the event of a resource that became healthy.

func New ¶

func New(id string, status api.EventStatus, text string, reason ...string) api.Resource

New builds an event about a resource; reason, if given, is kept as its details.

func Removed ¶

func Removed(id string) api.Resource

Removed is the event of a resource that was removed.

func Removing ¶

func Removing(id string) api.Resource

Removing is the event of a resource being removed.

func Skipped ¶

func Skipped(id string, reason string) api.Resource

Skipped is the event of a resource whose operation was skipped for the given reason.

func Stopped ¶

func Stopped(id string) api.Resource

Stopped is the event of a resource that was stopped.

func Stopping ¶

func Stopping(id string) api.Resource

Stopping is the event of a resource being stopped.

func Waiting ¶

func Waiting(id string) api.Resource

Waiting is the event of a resource waiting for another one.

Types ¶

type Noop ¶

type Noop struct{}

Noop is an api.EventProcessor that discards every event.

func (Noop) Done ¶

func (Noop) Done(string, bool)

Done does nothing.

func (Noop) On ¶

func (Noop) On(...api.Resource)

On does nothing.

func (Noop) Start ¶

func (Noop) Start(context.Context, string)

Start does nothing.

Source Files ¶

View all Source files

progress.go

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