Expand description
A line editing library providing an idiomatic Rust interface (Editor, History, Config,
Color, Hint, autocompletion, and multiline mode) derived from linenoise.
Structs§
- Config
- Configuration settings for an
Editorinstance. - Editor
- Interactive line editor instance.
- Hint
- Represents an inline hint displayed alongside the input buffer.
- History
- Manages input history for the line editor.
- Unbuffered
Stdout - An unbuffered writer to standard output using the
write(2)system call directly onlibc::STDOUT_FILENO.
Enums§
- Color
- Standard ANSI colors for hint text.
- Column
Width - Controls how the terminal window column width is determined.
- Operating
Mode - Represents the resolved concrete operating mode of the line editor.
- Readline
Error - Errors that can occur during line reading.
- Terminal
Capability - Represents the capability level of a terminal type name (e.g.,
TERMvariable or explicit configuration). - Terminal
Mode - Controls how TTY terminal capability detection is performed.
Constants§
- DEFAULT_
COLUMN_ COUNT - Default terminal column width when auto-detection fails.
- DEFAULT_
MAX_ HISTORY_ LEN - Default maximum number of history entries retained in memory.
- DEFAULT_
MAX_ LINE_ LEN - Default maximum length of an input line in bytes.
Traits§
- Completion
Handler - Closure type for tab completion handlers.
- Hint
Handler - Closure type for inline hint handlers.
Functions§
- readline
- Reads a line from stdin using default configuration.
- terminal_
capability_ from_ name - Classifies a terminal type name into a
TerminalCapability.