event

Documentation

Index

• Variables
• func DataOf[T any](e Event) T
• func From(event Event) *entry
• type AggID
• type Aggregate
• type Event
  • func For[Data any](a Aggregate, name string, data Data, opts ...Option) Event
  • func New(name string, data any, opts ...Option) Event
  • func (e Event) Aggregate() (AggID, string, int)
  • func (e Event) AggregateID() AggID
  • func (e Event) Data() interface{}
  • func (e Event) ID() ID
  • func (e Event) MarshalBSON() ([]byte, error)
  • func (e Event) Name() string
  • func (e Event) Time() time.Time
  • func (e *Event) UnmarshalBSON(data []byte) error
  • func (e Event) Version() int
• type ID
• type IEvent
• type Metadata
• type Option
  • func WithAggregate(a Aggregate) Option
  • func WithID(id ID) Option
  • func WithTime(t time.Time) Option
  • func WithType(id AggID, typeName string) Option
  • func WithTypeAndVersion(id AggID, typeName string, version int) Option

Variables

var EmptyEvent = Event{}

Functions

func DataOf

func DataOf[T any](e Event) T

func From

func From(event Event) *entry

Types

type AggID

type AggID = ids.ID

type Aggregate

type Aggregate interface {
	ID() ids.ID
	Type() string
	Version() int
}

type Event

type Event struct {
	// contains filtered or unexported fields
}

func For

func For[Data any](a Aggregate, name string, data Data, opts ...Option) Event

func New

func New(name string, data any, opts ...Option) Event

func (Event) Aggregate

func (e Event) Aggregate() (AggID, string, int)

func (Event) AggregateID

func (e Event) AggregateID() AggID

func (Event) Data

func (e Event) Data() interface{}

func (Event) ID

func (e Event) ID() ID

func (Event) MarshalBSON

func (e Event) MarshalBSON() ([]byte, error)

func (Event) Name

func (e Event) Name() string

func (Event) Time

func (e Event) Time() time.Time

func (*Event) UnmarshalBSON

func (e *Event) UnmarshalBSON(data []byte) error

func (Event) Version

func (e Event) Version() int

type ID

type ID = ids.ID

type IEvent

type IEvent interface {
	// ID returns the id of the event.
	ID() ID
	// Name returns the name of the event.
	Name() string
	// Time returns the time of the event.
	Time() time.Time
	// Data returns the event data.
	Data() interface{}
	// Aggregate returns the id, name and version of the aggregate that the
	// event belongs to. aggregate should return zero values if the event is not
	// an aggregate event.
	Aggregate() (id ids.ID, name string, version int)
}

type Metadata

type Metadata struct {
	ID               ID
	Name             string
	Time             time.Time
	AggregateName    string
	AggregateID      AggID
	AggregateVersion int
	Data             interface{}
}

type Option

type Option func(*Metadata)

func WithAggregate

func WithAggregate(a Aggregate) Option

func WithID

func WithID(id ID) Option

func WithTime

func WithTime(t time.Time) Option

func WithType

func WithType(id AggID, typeName string) Option

func WithTypeAndVersion

func WithTypeAndVersion(id AggID, typeName string, version int) Option