internal

Documentation

Index

• func HideCursor(w io.Writer)
• func ShowCursor(w io.Writer)
• func TriggerConsoleCSI(w io.Writer, seq string, a ...interface{})
• type CloseChan
  • func NewCloseChan() *CloseChan
  • func (r *CloseChan) Chan() chan struct{}
  • func (r *CloseChan) Close()
  • func (r *CloseChan) IsClosed() bool
• type Renderer
  • func NewRenderer(out *os.File, mtx *sync.Mutex) *Renderer
  • func (r *Renderer) Start()
  • func (r *Renderer) Stop()
  • func (r *Renderer) Write(s string)

Functions

func HideCursor

func HideCursor(w io.Writer)

func ShowCursor

func ShowCursor(w io.Writer)

func TriggerConsoleCSI

func TriggerConsoleCSI(w io.Writer, seq string, a ...interface{})

Types

type CloseChan

type CloseChan struct {
	// contains filtered or unexported fields
}

func NewCloseChan

func NewCloseChan() *CloseChan

func (*CloseChan) Chan

func (r *CloseChan) Chan() chan struct{}

func (*CloseChan) Close

func (r *CloseChan) Close()

func (*CloseChan) IsClosed

func (r *CloseChan) IsClosed() bool

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer is a timer-based Renderer, updating the view at a given framerate to avoid overloading the terminal emulator.

In cases where very high performance is needed the Renderer can be told to exclude ranges of lines, allowing them to be written to directly.

func NewRenderer

func NewRenderer(out *os.File, mtx *sync.Mutex) *Renderer

newRenderer creates a new Renderer. Normally you'll want to initialize it with os.Stdout as the first argument.

func (*Renderer) Start

func (r *Renderer) Start()

Start starts the Renderer.

func (*Renderer) Stop

func (r *Renderer) Stop()

Stop permanently halts the Renderer.

func (*Renderer) Write

func (r *Renderer) Write(s string)