progress

type DynamicRenderer ¶ added in v1.1.0

type DynamicRenderer interface {
	Renderer
	Done() <-chan struct{}
}

DynamicRenderer is a Renderer that can notify that its internal states are Done updating. DynamicRenderer is implemented by components that listen to events from a streamer and update their state.

func ListeningChangeSetRenderer(streamer StackSubscriber, stackName, description string, changes []Renderer, opts RenderOptions) DynamicRenderer

func ListeningECSServiceResourceRenderer(cfg ECSServiceRendererCfg, opts ECSServiceRendererOpts) DynamicRenderer

func ListeningEnvControllerRenderer(conf EnvControllerConfig) DynamicRenderer

func ListeningResourceRenderer(streamer StackSubscriber, logicalID, description string, opts ResourceRendererOpts) DynamicRenderer

func ListeningRollingUpdateRenderer(streamer ECSServiceSubscriber, opts RenderOptions) DynamicRenderer

func ListeningStackRenderer(streamer StackSubscriber, stackName, description string, resourceDescriptions map[string]string, opts RenderOptions) DynamicRenderer

func ListeningStackSetRenderer(streamer StackSetSubscriber, title string, opts RenderOptions) DynamicRenderer

func MultiRenderer(renderers ...DynamicRenderer) DynamicRenderer

type ECSServiceRendererCfg ¶ added in v1.27.0

type ECSServiceRendererCfg struct {
	Streamer    StackSubscriber
	ECSClient   stream.ECSServiceDescriber
	CWClient    stream.CloudWatchDescriber
	LogicalID   string
	Description string
}

ECSServiceRendererCfg holds required configuration for initializing an ECS service renderer.

type ECSServiceRendererOpts ¶ added in v1.2.0

type ECSServiceRendererOpts struct {
	Group      *errgroup.Group
	Ctx        context.Context
	RenderOpts RenderOptions
}

ECSServiceRendererOpts holds optional configuration for a listening ECS service renderer.

type ECSServiceSubscriber ¶ added in v1.2.0

type ECSServiceSubscriber interface {
	Subscribe() <-chan stream.ECSService
}

ECSServiceSubscriber is the interface to subscribe channels to ECS service descriptions.

type EnvControllerConfig ¶ added in v1.5.0

type EnvControllerConfig struct {
	// Common configuration.
	Description string
	RenderOpts  RenderOptions

	// Env controller action configuration.
	ActionStreamer  StackSubscriber
	ActionLogicalID string

	// Env stack configuration.
	EnvStreamer     StackSubscriber
	CancelEnvStream context.CancelFunc
	EnvStackName    string
	EnvResources    map[string]string
}

EnvControllerConfig holds the required parameters to create an environment controller component.

type FileWriteFlusher ¶ added in v1.1.0

type FileWriteFlusher interface {
	FileWriter
	WriteFlusher
}

FileWriteFlusher is the interface that groups a FileWriter and WriteFlusher.

type FileWriter ¶ added in v1.1.0

type FileWriter interface {
	io.Writer
	Fd() uintptr
}

FileWriter is the interface grouping an io.Writer with the file descriptor method Fd. Files in the OS, like os.Stderr, implement the FileWriter interface.

type RenderOptions ¶ added in v1.1.0

type RenderOptions struct {
	Padding int // Leading spaces before rendering the component.
}

RenderOptions holds optional style configuration for renderers.

func NestedRenderOptions(opts RenderOptions) RenderOptions

type Renderer ¶ added in v1.1.0

type Renderer interface {
	Render(out io.Writer) (numLines int, err error)
}

Renderer is the interface to print a component to a writer. It returns the number of lines printed and the error if any.

func LineRenderer(text string, padding int) Renderer

type ResourceRendererOpts ¶ added in v1.2.0

type ResourceRendererOpts struct {
	StartEvent *stream.StackEvent // Specify the starting event for the resource instead of "[not started]".
	RenderOpts RenderOptions
}

ResourceRendererOpts is optional configuration for a listening CloudFormation resource renderer.

type Spinner ¶

type Spinner struct {
	// contains filtered or unexported fields
}

Spinner represents an indicator that an asynchronous operation is taking place.

For short operations, less than 4 seconds, display only the spinner with the Start and Stop methods. For longer operations, display intermediate progress events using the Events method.

func NewSpinner(w io.Writer) *Spinner

func (s *Spinner) Start(label string)

func (s *Spinner) Stop(label string)

type StackSetSubscriber ¶ added in v1.21.1

type StackSetSubscriber interface {
	Subscribe() <-chan stream.StackSetOpEvent
}

StackSetSubscriber is the interface to subscribe channels to a CloudFormation stack set event stream.

type StackSubscriber ¶ added in v1.1.0

type StackSubscriber interface {
	Subscribe() <-chan stream.StackEvent
}

StackSubscriber is the interface to subscribe to a CloudFormation stack event stream.

type TabbedFileWriter ¶ added in v1.1.0

type TabbedFileWriter struct {
	FileWriter
	WriteFlusher
}

TabbedFileWriter is a FileWriter that also implements the WriteFlusher interface. A TabbedFileWriter can properly align text separated by the '\t' character.

func NewTabbedFileWriter(fw FileWriter) *TabbedFileWriter

func (w *TabbedFileWriter) Write(p []byte) (n int, err error)

type WriteFlusher ¶ added in v1.1.0

type WriteFlusher interface {
	io.Writer
	Flush() error
}

WriteFlusher is the interface grouping an io.Writer with the Flush method. Flush allows writing buffered writes from Writer all at once.