lined

package

v0.1.1 Latest Latest Go to latest Published: Aug 18, 2023 License: MIT Imports: 2 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/godevsig/glib

Links

Open Source Insights

Documentation ¶

Overview ¶

Package lined is line editor, supports operations on terminal.

Supported operations includes short-cut like Ctrl-A Ctrl-E Ctrl-C Ctrl-D... and UP/DOWN for history.

Index ¶

type Cfg
type Editor
- func NewEditor(cfg Cfg) *Editor
- func (ed *Editor) Close()
- func (ed *Editor) Readline() (line string, err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Cfg ¶

type Cfg struct {
	Prompt string
}

Cfg is the options that lined supports, used when New the Editor instance.

func NewEditor ¶

func NewEditor(cfg Cfg) *Editor

NewEditor returns an instance of Editor, with user defined Cfg.

func (*Editor) Close ¶

func (ed *Editor) Close()

Close returns the terminal to its previous mode.

func (*Editor) Readline ¶

func (ed *Editor) Readline() (line string, err error)

Readline reads and returns a line from input not including a trailing newline character. Readline returns empty line if user only inputs a newline. An io.EOF error is returned if user entered Ctrl-D. Support multi line continuation ending with "\".