mux

README

mux

Package mux defines Screen and Stream, two of cy's core abstractions for representing interactive windows and streams of terminal data, respectively. It also contains a wide range of useful Screens and Streams used across cy.

Documentation

Index

• type Msg
• type Resizable
• type Screen
• type Size
• type Stream
• type UpdatePublisher
  • func NewPublisher() *UpdatePublisher
  • func (u *UpdatePublisher) Notify()
• type Updater

Types

type Msg

type Msg = events.Msg

type Resizable

type Resizable interface {
	Resize(size Size) error
}

type Screen

type Screen interface {
	State() *tty.State
	Subscribe(context.Context) *Updater
	Resizable
	Send(message events.Msg)
}

A Screen is a resizable box that can publish updates.

type Size

type Size = geom.Vec2

type Stream

type Stream interface {
	io.ReadWriter
	Resizable
}

A Stream accepts input (Write) and resize events and produces output (Read).

type UpdatePublisher

type UpdatePublisher struct {
	*util.Publisher[events.Msg]
}

func NewPublisher

func NewPublisher() *UpdatePublisher

func (*UpdatePublisher) Notify

func (u *UpdatePublisher) Notify()

type Updater

type Updater = util.Subscriber[events.Msg]