minterm

package

v1.0.30 Latest Latest Go to latest Published: Sep 15, 2017 License: BSD-3-Clause, BSD-3-Clause Imports: 8 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

Rendered for

Package minterm implements minimal terminal functions.

This section is empty.

View Source

var ErrPromptInterrupted = errors.New("prompt interrupted")

This section is empty.

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

MinTerm is a minimal terminal interface.

func New() (*MinTerm, error)

New creates a new MinTerm and opens the terminal file. Any errors that happen while opening or getting the terminal size are returned.

func (m *MinTerm) Prompt(prompt string) (string, error)

Prompt gets a line of input from the terminal. It displays the text in the prompt parameter first.

func (m *MinTerm) PromptPassword(prompt string) (string, error)

PromptPassword gets a line of input from the terminal, but nothing is echoed to the terminal to hide the text.

func (m *MinTerm) Shutdown() error

Shutdown closes the terminal.

func (m *MinTerm) Size() (int, int)

Size returns the width and height of the terminal.

func (m *MinTerm) Write(s string) error

Write writes a string to the terminal.