progress

Documentation

Index

• func Run(ctx context.Context, pf progressFunc) (string, error)
• func WithContextWriter(ctx context.Context, writer Writer) context.Context
• type Event
  • func CreatedEvent(ID string) Event
  • func CreatingEvent(ID string) Event
  • func ErrorEvent(ID string) Event
  • func ErrorMessageEvent(ID string, msg string) Event
  • func NewEvent(ID string, status EventStatus, statusText string) Event
  • func RemovedEvent(ID string) Event
  • func RemovingEvent(ID string) Event
  • func RunningEvent(ID string) Event
  • func StartedEvent(ID string) Event
  • func StartingEvent(ID string) Event
  • func StoppingEvent(ID string) Event
• type EventStatus
• type Writer
  • func ContextWriter(ctx context.Context) Writer
  • func NewWriter(out console.File) (Writer, error)

Functions

func Run

func Run(ctx context.Context, pf progressFunc) (string, error)

Run will run a writer and the progress function in parallel

func WithContextWriter

func WithContextWriter(ctx context.Context, writer Writer) context.Context

WithContextWriter adds the writer to the context

Types

type Event

type Event struct {
	ID         string
	ParentID   string
	Text       string
	Status     EventStatus
	StatusText string
	// contains filtered or unexported fields
}

Event represents a progress event.

func CreatedEvent

func CreatedEvent(ID string) Event

CreatedEvent creates a new Created (done) Event

func CreatingEvent

func CreatingEvent(ID string) Event

CreatingEvent creates a new Create in progress Event

func ErrorEvent

func ErrorEvent(ID string) Event

ErrorEvent creates a new Error Event

func ErrorMessageEvent

func ErrorMessageEvent(ID string, msg string) Event

ErrorMessageEvent creates a new Error Event with message

func NewEvent

func NewEvent(ID string, status EventStatus, statusText string) Event

NewEvent new event

func RemovedEvent

func RemovedEvent(ID string) Event

RemovedEvent creates a new removed (done) Event

func RemovingEvent

func RemovingEvent(ID string) Event

RemovingEvent creates a new Removing in progress Event

func RunningEvent

func RunningEvent(ID string) Event

RunningEvent creates a new Running in progress Event

func StartedEvent

func StartedEvent(ID string) Event

StartedEvent creates a new Started in progress Event

func StartingEvent

func StartingEvent(ID string) Event

StartingEvent creates a new Starting in progress Event

func StoppingEvent

func StoppingEvent(ID string) Event

StoppingEvent stops a new Removing in progress Event

type EventStatus

type EventStatus int

EventStatus indicates the status of an action

const (
	// Working means that the current task is working
	Working EventStatus = iota
	// Done means that the current task is done
	Done
	// Error means that the current task has errored
	Error
)

type Writer

type Writer interface {
	Start(context.Context) error
	Stop()
	Event(Event)
}

Writer can write multiple progress events

func ContextWriter

func ContextWriter(ctx context.Context) Writer

ContextWriter returns the writer from the context

func NewWriter

func NewWriter(out console.File) (Writer, error)

NewWriter returns a new multi-progress writer