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
• type WriteEventReadStatus
  • func NewWriteEvent[T any](e Event[T]) WriteEventReadStatus[T]
• type WriteStatus

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 ByteWriteEvent, 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 (
	Create  Type = "create"
	Update  Type = "update"
	Delete  Type = "delete"
	Invalid Type = "invalid"
)

func AllTypes

func AllTypes() []Type

func TypeFromString

func TypeFromString(s string) Type

type WriteEvent

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

	Status chan<- WriteStatus
}

type WriteEventReadStatus

type WriteEventReadStatus[T any] interface {
	Event() Event[T]
	Done() <-chan struct{}
	Close()
}

func NewWriteEvent

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

type WriteStatus

type WriteStatus struct {
	Error    error
	Position uint64
	Time     time.Time
}