cwriter

package

v8.0.0-...-a3c40bf Latest Latest Go to latest Published: Sep 1, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/etoczek/mpb

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package cwriter is a console writer abstraction for the underlying OS.

Index ¶

Variables
func GetSize(fd int) (width, height int, err error)
func IsTerminal(fd int) bool
type Writer
- func New(out io.Writer) *Writer
- func (w *Writer) Flush(lines int) error
- func (w *Writer) GetTermSize() (width, height int, err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotTTY = errors.New("not a terminal")

ErrNotTTY not a TeleTYpewriter error.

Functions ¶

func GetSize ¶

func GetSize(fd int) (width, height int, err error)

GetSize returns the dimensions of the given terminal.

func IsTerminal ¶

func IsTerminal(fd int) bool

IsTerminal returns whether the given file descriptor is a terminal.

Types ¶

type Writer ¶

type Writer struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

Writer is a buffered terminal writer, which moves cursor N lines up on each flush except the first one, where N is a number of lines of a previous flush.

func New ¶

func New(out io.Writer) *Writer

New returns a new Writer with defaults.

func (*Writer) Flush ¶

func (w *Writer) Flush(lines int) error

Flush flushes the underlying buffer. It's caller's responsibility to pass correct number of lines.

func (*Writer) GetTermSize ¶

func (w *Writer) GetTermSize() (width, height int, err error)

GetTermSize returns WxH of underlying terminal.

Source Files ¶

View all Source files

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