observer

Documentation

Index

• func WithCopyObserver(ctx context.Context, obs CopyObserver) context.Context
• type CopyObserver
  • func ObserverFromContext(ctx context.Context) CopyObserver

Functions

func WithCopyObserver

func WithCopyObserver(ctx context.Context, obs CopyObserver) context.Context

WithCopyObserver stores a CopyObserver in the context.

Types

type CopyObserver

type CopyObserver interface {
	StageStart(name string)
	StageItem(name, detail string, current, total int64)
	StageDone(name, summary string)
	StageSkip(name, reason string)
	SubStageDone(stage, sub, summary string)
	StageWarning(stage, msg string)
}

CopyObserver receives progress events during copy operations. Implementations must be safe for concurrent use.

func ObserverFromContext

func ObserverFromContext(ctx context.Context) CopyObserver

ObserverFromContext returns the CopyObserver from context, or a no-op observer.