readlineutil

package module

v0.1.2 Latest Latest Go to latest Published: Mar 18, 2020 License: MIT Imports: 4 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/knieriem/readlineutil

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
type Option
- func WithHistoryFile(filename string) Option
type Term
- func NewTerm(options ...Option) (*Term, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotSupported = errors.New("not supported")

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(*conf)

func WithHistoryFile ¶

func WithHistoryFile(filename string) Option

WithHistoryFile configures a filename to be used to persist the command history.

type Term ¶

type Term struct {
	io.Writer
	// contains filtered or unexported fields
}

func NewTerm ¶

func NewTerm(options ...Option) (*Term, error)

NewTerm wraps a chzyer/readline.Instance so that it can be used in a way similar to bufio.Scanner. NewTerm does not check whether os.Stdin actually is a terminal. A nil Term and ErrNotSupported are returned in case NewTerm is called with TERM environment variable set to dumb.

func (*Term) Close ¶

func (t *Term) Close() error

func (*Term) Err ¶

func (t *Term) Err() error

func (*Term) Scan ¶

func (t *Term) Scan() bool

func (*Term) Text ¶

func (t *Term) Text() string

func (*Term) WritePrompt ¶

func (t *Term) WritePrompt(p string) error

Source Files ¶

View all Source files

readlineutil.go

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