event

Documentation

Index

• Variables
• type Builder
  • func NewBuilder() Builder
• type ByteEvent
• type ByteReadEvent
• type ByteWriteEvent
• type Event
• type Metadata
• type ReadEvent
• type ReadEventWAcc
• type Type
  • func AllTypes() []Type
  • func TypeFromString(s string) Type
• type WriteEvent
  • func (e *WriteEvent[T]) Close(status store.WriteStatus)
  • func (e *WriteEvent[T]) Done() <-chan store.WriteStatus
  • func (e *WriteEvent[T]) Event() *Event[T]
  • func (e *WriteEvent[T]) StatusChan() chan store.WriteStatus
  • func (e *WriteEvent[T]) Store() *store.WriteEvent
• type WriteEventReadStatus
  • func Map[OT, NT any](e WriteEventReadStatus[OT], f func(OT) NT) WriteEventReadStatus[NT]
  • func NewWrite[T any](t Type, data T, m Metadata) WriteEventReadStatus[T]
  • func NewWriteEvent[T any](e Event[T]) WriteEventReadStatus[T]

Variables

var InvalidTypeError = fmt.Errorf("event type is invalid")

Types

type Builder

type Builder interface {
	WithType(t Type) builder
	WithData(data []byte) builder
	WithMetadata(data Metadata) builder
	BuildRead() (ev ByteReadEvent, err error)
	BuildStore() (ev WriteEvent[[]byte], err error)
}

func NewBuilder

func NewBuilder() Builder

type ByteEvent

type ByteEvent Event[[]byte]

type ByteReadEvent

type ByteReadEvent ReadEvent[[]byte]

type ByteWriteEvent

type ByteWriteEvent WriteEvent[[]byte]

type Event

type Event[T any] struct {
	Type     Type     `json:"type"`
	Data     T        `json:"data"`
	Metadata Metadata `json:"metadata"`
}

type Metadata

type Metadata struct {
	Stream    string         `json:"stream"`
	EventType Type           `json:"event_type"`
	Version   string         `json:"version"`
	DataType  string         `json:"data_type"`
	Key       string         `json:"key"` //Strictly used for things like getting the cryptoKey
	Extra     map[string]any `json:"extra"`
	Created   time.Time      `json:"created"`
}

type ReadEvent

type ReadEvent[T any] struct {
	Event[T]

	Position uint64    `json:"position"`
	Created  time.Time `json:"created"`
}

type ReadEventWAcc

type ReadEventWAcc[T any] struct {
	ReadEvent[T]

	Acc func()
	CTX context.Context
}

type Type

type Type string

const (
	Created Type = "created"
	Updated Type = "updated"
	Deleted Type = "deleted"
	Invalid Type = "invalid"
)

func AllTypes

func AllTypes() []Type

func TypeFromString

func TypeFromString(s string) Type

type WriteEvent

type WriteEvent[T any] struct {
	// contains filtered or unexported fields
}

func (*WriteEvent[T]) Close

func (e *WriteEvent[T]) Close(status store.WriteStatus)

func (*WriteEvent[T]) Done

func (e *WriteEvent[T]) Done() <-chan store.WriteStatus

func (*WriteEvent[T]) Event

func (e *WriteEvent[T]) Event() *Event[T]

func (*WriteEvent[T]) StatusChan

func (e *WriteEvent[T]) StatusChan() chan store.WriteStatus

func (*WriteEvent[T]) Store

func (e *WriteEvent[T]) Store() *store.WriteEvent

type WriteEventReadStatus

type WriteEventReadStatus[T any] interface {
	Event() *Event[T]
	Done() <-chan store.WriteStatus
	Close(store.WriteStatus)
	Store() *store.WriteEvent
	StatusChan() chan store.WriteStatus
}

func Map

func Map[OT, NT any](e WriteEventReadStatus[OT], f func(OT) NT) WriteEventReadStatus[NT]

func NewWrite

func NewWrite[T any](t Type, data T, m Metadata) WriteEventReadStatus[T]

func NewWriteEvent

func NewWriteEvent[T any](e Event[T]) WriteEventReadStatus[T]