events

Documentation

Index

• type FuncPublisher
  • func ChannelPublisher[T any](events chan<- T) FuncPublisher[T]
  • func (f FuncPublisher[T]) Publish(ctx context.Context, e T) error
• type NilPublisher
  • func (f NilPublisher[T]) Publish(ctx context.Context, e T) error
• type Publisher

Types

type FuncPublisher

type FuncPublisher[T any] func(context.Context, T) error

FuncPublisher wraps a plain func as a Publisher.

func ChannelPublisher

func ChannelPublisher[T any](events chan<- T) FuncPublisher[T]

ChannelPublisher wraps a plain channel as a Publisher.

func (FuncPublisher[T]) Publish

func (f FuncPublisher[T]) Publish(ctx context.Context, e T) error

Publish implements Publisher for FuncPublisher.

type NilPublisher

type NilPublisher[T any] struct{}

NilPublisher is a publisher than does nothing and returns no errors. Useful for testing.

func (NilPublisher[T]) Publish

func (f NilPublisher[T]) Publish(ctx context.Context, e T) error

Publish implements Publisher for NilPublisher.

type Publisher

type Publisher[T any] interface {
	Publish(context.Context, T) error
}

Publisher defines an interface on which the Docker lib publishes asynchronous events, such as logs or stats.