Enum rustyline::Cmd

#[non_exhaustive]
pub enum Cmd {
    Abort,
    AcceptLine,
    BeginningOfHistory,
    CapitalizeWord,
    ClearScreen,
    PasteFromClipboard,
    Complete,
    CompleteBackward,
    CompleteHint,
    Dedent(Movement),
    DowncaseWord,
    EndOfFile,
    EndOfHistory,
    ForwardSearchHistory,
    HistorySearchBackward,
    HistorySearchForward,
    Indent(Movement),
    Insert(RepeatCount, String),
    Interrupt,
    Kill(Movement),
    Move(Movement),
    NextHistory,
    Noop,
    Overwrite(char),
    PreviousHistory,
    QuotedInsert,
    ReplaceChar(RepeatCount, char),
    Replace(Movement, Option<String>),
    ReverseSearchHistory,
    SelfInsert(RepeatCount, char),
    Suspend,
    TransposeChars,
    TransposeWords(RepeatCount),
    Undo(RepeatCount),
    Unknown,
    UpcaseWord,
    ViYankTo(Movement),
    Yank(RepeatCount, Anchor),
    YankPop,
    LineUpOrPreviousHistory(RepeatCount),
    LineDownOrNextHistory(RepeatCount),
    Newline,
    AcceptOrInsertLine {
        accept_in_the_middle: bool,
    },
}

Commands

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Abort

abort

AcceptLine

accept-line

See also AcceptOrInsertLine

BeginningOfHistory

beginning-of-history

CapitalizeWord

capitalize-word

ClearScreen

clear-screen

PasteFromClipboard

Paste from the clipboard

Complete

complete

CompleteBackward

complete-backward

CompleteHint

complete-hint

Dedent(Movement)

Tuple Fields

0: Movement

Dedent current line

DowncaseWord

downcase-word

EndOfFile

vi-eof-maybe

EndOfHistory

end-of-history

ForwardSearchHistory

forward-search-history (incremental search)

HistorySearchBackward

history-search-backward (common prefix search)

HistorySearchForward

history-search-forward (common prefix search)

Indent(Movement)

Tuple Fields

0: Movement

Indent current line

Insert(RepeatCount, String)

Tuple Fields

0: RepeatCount

1: String

Insert text

Interrupt

Interrupt signal (Ctrl-C)

Kill(Movement)

Tuple Fields

0: Movement

backward-delete-char, backward-kill-line, backward-kill-word delete-char, kill-line, kill-word, unix-line-discard, unix-word-rubout, vi-delete, vi-delete-to, vi-rubout

Move(Movement)

Tuple Fields

0: Movement

backward-char, backward-word, beginning-of-line, end-of-line, forward-char, forward-word, vi-char-search, vi-end-word, vi-next-word, vi-prev-word

NextHistory

next-history

Noop

No action

Overwrite(char)

Tuple Fields

0: char

vi-replace

PreviousHistory

previous-history

QuotedInsert

quoted-insert

ReplaceChar(RepeatCount, char)

Tuple Fields

0: RepeatCount

1: char

vi-change-char

Replace(Movement, Option<String>)

Tuple Fields

0: Movement

1: Option<String>

vi-change-to, vi-substitute

ReverseSearchHistory

reverse-search-history (incremental search)

SelfInsert(RepeatCount, char)

Tuple Fields

0: RepeatCount

1: char

self-insert

Suspend

Suspend signal (Ctrl-Z on unix platform)

TransposeChars

transpose-chars

TransposeWords(RepeatCount)

Tuple Fields

0: RepeatCount

transpose-words

Undo(RepeatCount)

Tuple Fields

0: RepeatCount

undo

Unknown

Unsupported / unexpected

UpcaseWord

upcase-word

ViYankTo(Movement)

Tuple Fields

0: Movement

vi-yank-to

Yank(RepeatCount, Anchor)

Tuple Fields

0: RepeatCount

1: Anchor

yank, vi-put

YankPop

yank-pop

LineUpOrPreviousHistory(RepeatCount)

Tuple Fields

0: RepeatCount

moves cursor to the line above or switches to prev history entry if the cursor is already on the first line

LineDownOrNextHistory(RepeatCount)

Tuple Fields

0: RepeatCount

moves cursor to the line below or switches to next history entry if the cursor is already on the last line

Newline

Inserts a newline

AcceptOrInsertLine

Fields

accept_in_the_middle: bool

Whether this commands accepts input if the cursor not at the end of the current input

Either accepts or inserts a newline

Always inserts newline if input is non-valid. Can also insert newline if cursor is in the middle of the text

If you support multi-line input:

• Use accept_in_the_middle: true for mostly single-line cases, for example command-line.
• Use accept_in_the_middle: false for mostly multi-line cases, for example SQL or JSON input.

Implementations

impl Cmd

pub fn should_reset_kill_ring(&self) -> bool

Tells if current command should reset kill ring.

Trait Implementations

impl Clone for Cmd

fn clone(&self) -> Cmd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cmd

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

Formats the value using the given formatter.

impl From<Cmd> for EventHandler

fn from(c: Cmd) -> EventHandler

Performs the conversion.

impl PartialEq<Cmd> for Cmd

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

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

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

This method tests for !=.

impl StructuralPartialEq for Cmd