cursor

Documentation

Overview

Package cursor provides functionality to interact with the terminal cursor.

Index

• func EraseLine(fw terminal.FileWriter)
• func EraseLinesAbove(fw terminal.FileWriter, n int)
• func TestEraseLine(t *testing.T)
• type Cursor
  • func New() *Cursor
  • func NewWithWriter(out io.Writer) *Cursor
  • func (c *Cursor) Down(n int)
  • func (c *Cursor) EraseLine()
  • func (c *Cursor) Hide()
  • func (c *Cursor) Show()
  • func (c *Cursor) Up(n int)

Functions

func EraseLine

func EraseLine(fw terminal.FileWriter)

EraseLine erases a line from a FileWriter.

func EraseLinesAbove

func EraseLinesAbove(fw terminal.FileWriter, n int)

EraseLinesAbove erases a line and moves the cursor up from fw, repeated n times.

func TestEraseLine

func TestEraseLine(t *testing.T)

TestEraseLine is POSIX-only since the implementation in the underlying library is completely different on Windows.

Types

type Cursor

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

Cursor represents the terminal's cursor.

func New

func New() *Cursor

New creates a new cursor that writes to stderr.

func NewWithWriter

func NewWithWriter(out io.Writer) *Cursor

New creates a new cursor that writes to the given out writer.

func (*Cursor) Down

func (c *Cursor) Down(n int)

Down moves the cursor n lines.

func (*Cursor) EraseLine

func (c *Cursor) EraseLine()

EraseLine deletes the contents of the current line.

func (*Cursor) Hide

func (c *Cursor) Hide()

Hide makes the cursor invisible.

func (*Cursor) Show

func (c *Cursor) Show()

Show makes the cursor visible.

func (*Cursor) Up

func (c *Cursor) Up(n int)

Up moves the cursor n lines.