readline

package

v0.0.0-...-b98e16c Latest Latest Go to latest Published: Feb 5, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NexaAI/nexa-sdk

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
type Buffer
- func NewBuffer(prompt, altPrompt string) *Buffer
type Config
type History
- func NewHistory(file string) *History
type Readline
- func New(config *Config) (*Readline, error)
- func (rl *Readline) Close() error
- func (rl *Readline) Read() (string, error)
type Terminal
- func NewTerminal() (*Terminal, error)
type Termios

Constants ¶

View Source

const (
	Null      = 0
	CtrlA     = 1
	CtrlB     = 2
	CtrlC     = 3
	CtrlD     = 4
	CtrlE     = 5
	CtrlF     = 6
	Bell      = 7
	CtrlH     = 8
	Tab       = 9
	CtrlJ     = 10
	Kill      = 11
	CtrlL     = 12
	Enter     = 13
	Next      = 14
	Prev      = 16
	BckSearch = 18
	FwdSearch = 19
	Transpose = 20
	CtrlU     = 21
	CtrlW     = 23
	CtrlY     = 25
	CtrlZ     = 26
	Esc       = 27
	Backspace = 127
)

Variables ¶

View Source

var (
	ErrComplete = errors.New("Complete") // readline complete

	ErrInterrupt = errors.New("Interrupt")
)

Functions ¶

This section is empty.

Types ¶

type Buffer ¶

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

TODO: placeholder

func NewBuffer ¶

func NewBuffer(prompt, altPrompt string) *Buffer

type Config ¶

type Config struct {
	Prompt      string
	AltPrompt   string
	HistoryFile string
}

type History ¶

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

TODO: implement history persistence

func NewHistory ¶

func NewHistory(file string) *History

func (*History) Add ¶

func (h *History) Add(entry []rune)

func (*History) Next ¶

func (h *History) Next() []rune

func (*History) Prev ¶

func (h *History) Prev() []rune

func (*History) Save ¶

func (h *History) Save() error

type Readline ¶

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

func New ¶

func New(config *Config) (*Readline, error)

func (*Readline) Close ¶

func (rl *Readline) Close() error

func (*Readline) Read ¶

func (rl *Readline) Read() (string, error)

type Terminal ¶

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

func NewTerminal ¶

func NewTerminal() (*Terminal, error)

func (*Terminal) Close ¶

func (t *Terminal) Close() error

func (*Terminal) EnterRaw ¶

func (t *Terminal) EnterRaw() error

func (*Terminal) ExitRaw ¶

func (t *Terminal) ExitRaw() error

func (*Terminal) Read ¶

func (t *Terminal) Read() (rune, error)

type Termios ¶

type Termios syscall.Termios

Source Files ¶

View all Source files

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