events

README

Builtins: event

A rudimentary event system for murex

Documentation

Overview

Package events provides a basic event framework for murex

Index

• func AddEventType(eventTypeName string, handlerInterface eventType, err error) error
• func Callback(name string, interrupt interface{}, block []rune, fileRef *ref.File, ...) (any, error)
• func CompileInterruptKey(interrupt, name string) string
• func DumpEventTypes() []string
• func DumpEvents() (dump map[string]interface{})
• type DumpT
• type Key
  • func GetInterruptFromKey(key string) *Key

Functions

func AddEventType

func AddEventType(eventTypeName string, handlerInterface eventType, err error) error

AddEventType registers your event type handlers

func Callback

func Callback(name string, interrupt interface{}, block []rune, fileRef *ref.File, stdout, stderr stdio.Io, evtReturn any, background bool) (any, error)

Callback is a generic function your event handlers types should hook into so murex functions can remain consistent.

func CompileInterruptKey

func CompileInterruptKey(interrupt, name string) string

func DumpEventTypes

func DumpEventTypes() []string

func DumpEvents

func DumpEvents() (dump map[string]interface{})

DumpEvents is used for `runtime` to output all the saved events

Types

type DumpT

type DumpT struct {
	Interrupt string
	Block     string
	FileRef   *ref.File
}

type Key

type Key struct {
	Name      string
	Interrupt string
}

func GetInterruptFromKey

func GetInterruptFromKey(key string) *Key

GetInterruptFromKey returns: name, interrupt