events

Documentation

Overview

Package events implements functions dealing with channels of tcell.Event.

Index

• func ContextWith(ctx context.Context, events chan<- tcell.Event) context.Context
• func FromContext(ctx context.Context) chan<- tcell.Event
• func Post(ctx context.Context, newEvent func() tcell.Event) (done bool)
• func PostEvent(ctx context.Context, ev tcell.Event) (done bool)
• func PostFunc(ctx context.Context, fn func()) (done bool)
• func PostFuncTicker(ctx context.Context, fn func(), d time.Duration)

Functions

func ContextWith

func ContextWith(ctx context.Context, events chan<- tcell.Event) context.Context

ContextWith returns a context.Context with the events channel.

func FromContext

func FromContext(ctx context.Context) chan<- tcell.Event

FromContext returns the events channel from ctx.

func Post

func Post(ctx context.Context, newEvent func() tcell.Event) (done bool)

Post sends a newEvent.

func PostEvent

func PostEvent(ctx context.Context, ev tcell.Event) (done bool)

PostEvent sends ev.

func PostFunc

func PostFunc(ctx context.Context, fn func()) (done bool)

PostFunc sends an event that executes fn.

func PostFuncTicker

func PostFuncTicker(ctx context.Context, fn func(), d time.Duration)

PostFuncTicker sends an event that executes fn every period of time d. Should be called as a new goroutine.