events

package

v0.19.5 Latest Latest Go to latest Published: Mar 19, 2022 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

This section is empty.

type Bus chan Event

Bus is a send/receive event bus.

func NewBus() Bus

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

func (b Bus) Send(e Event)

Send sends a new event to bus.

func (b Bus) Shutdown()

Shutdown shutdowns event bus.

type Event struct {

	// Description of the state.
	Description string
	// contains filtered or unexported fields
}

Event represents a state.

func New(status Status, description string) Event

New creates a new event with given config.

func (e Event) IsOngoing() bool

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

func (e Event) Text() string

Text returns the text state of event.

type Status int

Status shows if state is ongoing or completed.

const (
	StatusOngoing Status = iota
	StatusDone
)