Enum reedline::ReedlineEvent

pub enum ReedlineEvent {
    None,
    HistoryHintComplete,
    HistoryHintWordComplete,
    CtrlD,
    CtrlC,
    ClearScreen,
    ClearScrollback,
    Enter,
    Submit,
    SubmitOrNewline,
    Esc,
    Mouse,
    Resize(u16, u16),
    Edit(Vec<EditCommand>),
    Repaint,
    PreviousHistory,
    Up,
    Down,
    Right,
    Left,
    NextHistory,
    SearchHistory,
    Multiple(Vec<ReedlineEvent>),
    UntilFound(Vec<ReedlineEvent>),
    Menu(String),
    MenuNext,
    MenuPrevious,
    MenuUp,
    MenuDown,
    MenuLeft,
    MenuRight,
    MenuPageNext,
    MenuPagePrevious,
    ExecuteHostCommand(String),
    OpenEditor,
}

Reedline supported actions.

Variants

None

No op event

HistoryHintComplete

Complete history hint (default in full)

HistoryHintWordComplete

Complete a single token/word of the history hint

CtrlD

Handle EndOfLine event

Expected Behavior:

• On empty line breaks execution to exit with Signal::CtrlD
• Secondary behavior EditCommand::Delete

CtrlC

Handle SIGTERM key input

Expected behavior:

Abort entry Run EditCommand::Clear Clear the current undo Bubble up Signal::CtrlC

ClearScreen

Clears the screen and sets prompt to first line

ClearScrollback

Clears the screen and the scrollback buffer

Sets the prompt back to the first line

Enter

Handle enter event

Submit

Handle unconditional submit event

SubmitOrNewline

Submit at the end of the complete text, otherwise newline

Esc

Esc event

Mouse

Mouse

Resize(u16, u16)

trigger terminal resize

Edit(Vec<EditCommand>)

Run these commands in the editor

Repaint

Trigger full repaint

PreviousHistory

Navigate to the previous historic buffer

Up

Move up to the previous line, if multiline, or up into the historic buffers

Down

Move down to the next line, if multiline, or down through the historic buffers

Right

Move right to the next column, completion entry, or complete hint

Left

Move left to the next column, or completion entry

NextHistory

Navigate to the next historic buffer

SearchHistory

Search the history for a string

Multiple(Vec<ReedlineEvent>)

In vi mode multiple reedline events can be chained while parsing the command or movement characters

UntilFound(Vec<ReedlineEvent>)

Test

Menu(String)

Trigger a menu event. It activates a menu with the event name

MenuNext

Next element in the menu

MenuPrevious

Previous element in the menu

MenuUp

Moves up in the menu

MenuDown

Moves down in the menu

MenuLeft

Moves left in the menu

MenuRight

Moves right in the menu

MenuPageNext

Move to the next history page

MenuPagePrevious

Move to the previous history page

ExecuteHostCommand(String)

Way to bind the execution of a whole command (directly returning from crate::Reedline::read_line()) to a keybinding

OpenEditor

Open text editor

Trait Implementations

impl Clone for ReedlineEvent

fn clone(&self) -> ReedlineEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReedlineEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReedlineEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ReedlineEvent

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

Formats the value using the given formatter.

impl IntoEnumIterator for ReedlineEvent

type Iterator = ReedlineEventIter

fn iter() -> ReedlineEventIter

impl PartialEq for ReedlineEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReedlineEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ReedlineEvent

impl StructuralPartialEq for ReedlineEvent