events

package

v0.0.0-...-e081c89 Latest Latest Go to latest Published: Feb 17, 2024 License: GPL-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lmorg/murex

Links

Open Source Insights

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, ...)
func DumpEvents() (dump map[string]interface{})
type DumpT

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 stdio.Io, background bool)

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

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
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
onCommandCompletion
onFileSystemChange
onKeyPress
onPrompt
onSecondsElapsed
onSignalReceived

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL