bind

Documentation

Index

• func NewScope[T any](source interface{}) *trie.Trie[T]
• type Action
• type ActionEvent
• type BindEvent
• type BindScope
  • func NewBindScope(source interface{}) *BindScope
• type Engine
  • func NewEngine[T any]() *Engine[T]
  • func Run[T any](ctx context.Context, binds *trie.Trie[T]) *Engine[T]
  • func (e *Engine[T]) Input(data []byte)
  • func (e *Engine[T]) InputMessage(msg taro.Msg) (consumed bool)
  • func (e *Engine[T]) Poll(ctx context.Context)
  • func (e *Engine[T]) Recv() <-chan Event
  • func (e *Engine[T]) Scopes() []*trie.Trie[T]
  • func (e *Engine[T]) SetScopes(scopes ...*trie.Trie[T])
• type Event
• type Match
• type PartialEvent

Functions

func NewScope

func NewScope[T any](source interface{}) *trie.Trie[T]

Types

type Action

type Action struct {
	// An arbitrary string tag stored alongside the binding.
	// Used just for docs, for now.
	Tag string
	// The Janet callback invoked when this binding is fired.
	Callback *janet.Function
}

type ActionEvent

type ActionEvent[T any] struct {
	Action   T
	Engine   *Engine[T]
	Source   *trie.Trie[T]
	Sequence []string
	// Any regex traversals that matched
	Args []string
}

An action was triggered

type BindEvent

type BindEvent = ActionEvent[Action]

type BindScope

type BindScope = trie.Trie[Action]

func NewBindScope

func NewBindScope(source interface{}) *BindScope

type Engine

type Engine[T any] struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine[T any]() *Engine[T]

func Run

func Run[T any](ctx context.Context, binds *trie.Trie[T]) *Engine[T]

func (*Engine[T]) Input

func (e *Engine[T]) Input(data []byte)

Process input and produce events.

func (*Engine[T]) InputMessage

func (e *Engine[T]) InputMessage(msg taro.Msg) (consumed bool)

InputMessage directly passes a taro.Msg (which is typically a taro.KeyMsg) into the binding engine. If the key was "consumed", or produced either a partial or full match, InputMessage returns true.

func (*Engine[T]) Poll

func (e *Engine[T]) Poll(ctx context.Context)

func (*Engine[T]) Recv

func (e *Engine[T]) Recv() <-chan Event

func (*Engine[T]) Scopes

func (e *Engine[T]) Scopes() []*trie.Trie[T]

func (*Engine[T]) SetScopes

func (e *Engine[T]) SetScopes(scopes ...*trie.Trie[T])

type Event

type Event interface{}

type Match

type Match[T any] struct {
	Bind   trie.Leaf[T]
	Source *trie.Trie[T]
}

type PartialEvent

type PartialEvent[T any] struct {
	Prefix  []string
	Matches []Match[T]
}

There are partial matches