event

Documentation

Overview

Package event implements a simple event stream and defines all events generated by different parts of Terramate.

Index

• type Stream
  • func NewStream[T any](buffsize int) Stream[T]
  • func (s Stream[T]) Send(event T) bool
• type VendorProgress
• type VendorRequest

Types

type Stream

type Stream[T any] chan T

Stream is a stream of events.

func NewStream

func NewStream[T any](buffsize int) Stream[T]

NewStream creates a new stream.

func (Stream[T]) Send

func (s Stream[T]) Send(event T) bool

Send event on this event stream. Returns true if stream is not full, false if the stream is full.

type VendorProgress

type VendorProgress struct {
	Message   string
	TargetDir project.Path
	Module    tf.Source
}

VendorProgress represents a vendor progress event.

type VendorRequest

type VendorRequest struct {
	// Source is the source of the module.
	Source tf.Source
	// VendorDir is where the source is supposed to be vendored.
	VendorDir project.Path
}

VendorRequest represents an event indicating that a request to vendor was made.