cwriter

package
v4.12.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 5, 2020 License: Unlicense Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var NotATTY = errors.New("not a terminal")

NotATTY not a TeleTYpewriter error.

Functions

This section is empty.

Types

type Writer

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

Writer is a buffered the writer that updates the terminal. The contents of writer will be flushed when Flush is called.

func New

func New(out io.Writer) *Writer

New returns a new Writer with defaults.

func (*Writer) Flush

func (w *Writer) Flush(lineCount int) (err error)

Flush flushes the underlying buffer.

func (*Writer) GetWidth

func (w *Writer) GetWidth() (int, error)

GetWidth returns width of underlying terminal.

func (*Writer) ReadFrom

func (w *Writer) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads from the provided io.Reader and writes to the underlying buffer.

func (*Writer) Write

func (w *Writer) Write(p []byte) (n int, err error)

Write appends the contents of p to the underlying buffer.

func (*Writer) WriteString

func (w *Writer) WriteString(s string) (n int, err error)

WriteString writes string to the underlying buffer.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL