events

Documentation

Overview

Package events provides functionalities for packages to log their states as events for others to consume and display to end users in meaningful ways.

Index

• type Bus
  • func NewBus() Bus
  • func (b Bus) Send(e Event)
  • func (b Bus) Shutdown()
• type Event
  • func New(status Status, description string, options ...Option) Event
  • func (e Event) IsOngoing() bool
  • func (e Event) Text() string
• type Option
  • func Icon(icon string) Option
  • func TextColor(c color.Color) Option
• type Status

Types

type Bus

type Bus chan Event

Bus is a send/receive event bus.

func NewBus

func NewBus() Bus

NewBus creates a new event bus to send/receive events.

func (Bus) Send

func (b Bus) Send(e Event)

Send sends a new event to bus.

func (Bus) Shutdown

func (b Bus) Shutdown()

Shutdown shutdowns event bus.

type Event

type Event struct {
	// Description of the state.
	Description string

	// Status shows the current status of event.
	Status Status

	// TextColor of the text.
	TextColor color.Color

	// Icon of the text.
	Icon string
}

Event represents a state.

func New

func New(status Status, description string, options ...Option) Event

New creates a new event with given config.

func (Event) IsOngoing

func (e Event) IsOngoing() bool

IsOngoing checks if state change that triggered this event is still ongoing.

func (Event) Text

func (e Event) Text() string

Text returns the text state of event.

type Option

type Option func(*Event)

Option event options

func Icon

func Icon(icon string) Option

Icon sets the text icon prefix

func TextColor

func TextColor(c color.Color) Option

TextColor sets the text color

type Status

type Status int

Status shows if state is ongoing or completed.

const (
	StatusOngoing Status = iota
	StatusDone
)