es

README

es

Event stream in go

Documentation

Index

• Constants
• type Error
  • func (e Error) Error() string
• type Event
• type Identity
• type Model
  • func NewModel(identity Identity) *Model
• type PublisherOption
• type Record
• type Streamer
  • func NewStreamer(streamName string) (Streamer, error)
• type Unmarshaler
  • func NewUnmarshaler(events ...interface{}) *Unmarshaler
  • func (unmarshaler Unmarshaler) Unmarshal(data []byte) (interface{}, error)

Constants

const (
	// ErrMarshalEvent -
	ErrMarshalEvent = Error("unable to marshal event")

	// ErrUnmarshalEvent -
	ErrUnmarshalEvent = Error("unable to unmarshal event")

	// ErrUnknownEventType -
	ErrUnknownEventType = Error("unknown event type")
)

Types

type Error

type Error string

Error -

func (Error) Error

func (e Error) Error() string

type Event

type Event interface{}

Event -

type Identity

type Identity struct {
	UserID    string `json:"_au"`
	UserOrgID string `json:"_ao"`
	UserRole  string `json:"_ar"`
}

type Model

type Model struct {
	EventID  string    `json:"_e"`
	Version  int       `json:"_v"`
	At       time.Time `json:"_t"`
	Identity Identity  `json:"_i"`
}

Model -

func NewModel

func NewModel(identity Identity) *Model

type PublisherOption

type PublisherOption func() error

type Record

type Record struct {
	At   time.Time
	Type string
	Data string
}

TODO: rename to Entry

type Streamer

type Streamer interface {
	Commit(partitionKey string, event Event) error
	Push(ctx context.Context) error
	Clear()
}

Streamer -

func NewStreamer

func NewStreamer(streamName string) (Streamer, error)

NewStreamer - Options:

|> stream-name - required
|> kinesis-region - optional
|> retry policy - optional

type Unmarshaler

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

Unmarshaler - TODO: add init methods for binding

func NewUnmarshaler

func NewUnmarshaler(events ...interface{}) *Unmarshaler

NewUnmarshaler -

func (Unmarshaler) Unmarshal

func (unmarshaler Unmarshaler) Unmarshal(data []byte) (interface{}, error)

Unmarshal -