Skip to main content

OperatingMode

Enum OperatingMode 

Source
pub enum OperatingMode {
    NonTty,
    PromptOnly,
    UartEcho,
    Interactive,
}
Expand description

Represents the resolved concrete operating mode of the line editor.

OperatingMode determines how line-editor handles input streams, character echoing, escape sequences, line editing keybindings, and prompt rendering.

Variants§

§

NonTty

Non-TTY mode (e.g., input redirected from a file, pipe, or non-interactive script).

  • When used: Resolved when standard input is not a terminal stream, or when TerminalMode::NonTty is explicitly configured.
  • Consequences: No prompt is printed to the output stream. Escape sequences, raw mode, completion, hints, and line-editing keybindings are completely disabled. Input bytes are read sequentially until a newline or EOF is reached.
§

PromptOnly

Prompt-only mode for unsupported or dumb terminals (e.g., TERM=dumb, cons25, emacs).

  • When used: Resolved when the terminal capability check determines the terminal does not support ANSI/VT100 escape sequences.
  • Consequences: The prompt is written to the output stream before reading input, but ANSI/VT100 control sequences (cursor positioning, line clearing, colorized hints) and raw mode editing are disabled. Standard stream line buffering applies.
§

UartEcho

UART character echo mode (e.g., TERM=uart or serial console).

  • When used: Resolved when connected to a serial UART console that lacks full ANSI/VT100 screen manipulation but requires character-by-character echoing.
  • Consequences: The prompt is printed, and typed characters are echoed back to the output stream byte-by-byte. Basic backspace erasing (\x08 \x08) is handled, but complex VT100 cursor movement and multi-line editing are disabled.
§

Interactive

Full interactive VT100/ANSI terminal mode.

  • When used: Resolved when connected to an interactive TTY terminal supporting ANSI/VT100 control sequences (e.g., xterm, vt100, screen, tmux).
  • Consequences: Full raw-mode line editing with VT100 escape sequence handling, cursor movement, history navigation, tab autocompletion, inline hints, and multi-line refresh. Writes a trailing newline upon line submission.

Trait Implementations§

Source§

impl Clone for OperatingMode

Source§

fn clone(&self) -> OperatingMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for OperatingMode

Source§

impl Debug for OperatingMode

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for OperatingMode

Source§

impl PartialEq for OperatingMode

Source§

fn eq(&self, other: &OperatingMode) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OperatingMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.