event

Documentation

Overview

Package event is the event handler

Index

• Variables
• type Anything
• type HandlerDoneErr
  • func (e HandlerDoneErr) Error() string
  • func (e HandlerDoneErr) Unwrap() error
• type Loop
  • func (l *Loop) FindHandlers()
  • func (l *Loop) Fire(event any) (err error)
  • func (l *Loop) FireFound(event any) (found bool, err error)
  • func (l *Loop) Start() (err error)
• type OnStart
• type Tick
• type Unhandled

Variables

var ErrDontForward = errors.New("dont forward")

ErrDontForward will stop the event from being forwarded to other handlers, including anything handlers.

Types

type Anything

type Anything struct {
	Val any
}

type HandlerDoneErr

type HandlerDoneErr struct {
	Return error
}

HandlerDoneErr will stop the event loop and return the error if provided.

func (HandlerDoneErr) Error

func (e HandlerDoneErr) Error() string

func (HandlerDoneErr) Unwrap

func (e HandlerDoneErr) Unwrap() error

type Loop

type Loop struct {
	HandlerFunctions map[reflect.Type][]reflect.Value
	Handlers         []any
	HandlerIndex     int
}

func (*Loop) FindHandlers

func (l *Loop) FindHandlers()

FindHandlers initializes and populates the HandlerFunctions map by reflecting over methods of registered handlers.

func (*Loop) Fire

func (l *Loop) Fire(event any) (err error)

Fire dispatches the provided event to all appropriate handlers and invokes fallback handlers if the event is unhandled.

func (*Loop) FireFound

func (l *Loop) FireFound(event any) (found bool, err error)

FireFound triggers all handlers registered for the specified event type and returns if handlers were found or an error occurred.

func (*Loop) Start

func (l *Loop) Start() (err error)

type OnStart

type OnStart struct{}

type Tick

type Tick struct{}

type Unhandled

type Unhandled struct {
	Val any
}