Enum Action 

pub enum Action<A: ActionExt = NullActionExt> {
    Select,
    Deselect,
    Toggle,
    CycleAll,
    ClearSelections,
    Accept,
    Quit(i32),
    ToggleWrap,
    CycleSort,
    CyclePreview,
    Preview(String),
    Help(String),
    SetPreview(Option<u8>),
    SwitchPreview(Option<u8>),
    ToggleWrapPreview,
    HScroll(i8),
    PreviewHScroll(i8),
    PreviewScroll(i8),
    PreviewJump,
    SetInput(String),
    SetHeader(Option<String>),
    SetFooter(Option<String>),
    SetPrompt(Option<String>),
    Column(usize),
    CycleColumn,
    ColumnLeft,
    ColumnRight,
    ScrollLeft,
    ScrollRight,
    Execute(String),
    Become(String),
    Reload(String),
    Print(String),
    HistoryUp,
    HistoryDown,
    ChangePrompt,
    ChangeQuery,
    ForwardChar,
    BackwardChar,
    ForwardWord,
    BackwardWord,
    DeleteChar,
    DeleteWord,
    DeleteLineStart,
    DeleteLineEnd,
    Cancel,
    InputPos(i32),
    Up(u16),
    Down(u16),
    PreviewUp(u16),
    PreviewDown(u16),
    PreviewHalfPageUp,
    PreviewHalfPageDown,
    Pos(i32),
    Input(char),
    Redraw,
    Custom(A),
    Overlay(usize),
}

Bindable actions

Additional

See [crate::render::render_loop] for the source code definitions.

Variants

Select

Add item to selections

Deselect

Remove item from selections

Toggle

Toggle item in selections

CycleAll

Toggle all selections

ClearSelections

Clear all selections

Accept

Accept current selection

Quit(i32)

Quit with code

ToggleWrap

Toggle wrap

CycleSort

CyclePreview

Cycle preview layouts

Preview(String)

Show/hide preview for selection

Help(String)

Show help in preview

SetPreview(Option<u8>)

Set preview layout; None restores the command of the current layout.

SwitchPreview(Option<u8>)

Switch or toggle preview;

ToggleWrapPreview

Toggle wrap in preview

HScroll(i8)

Horizontally scroll either results or preview based on mouse location and wrapping configuration. (unimplemented) 0 to reset.

PreviewHScroll(i8)

Persistent horizontal scroll 0 to reset.

PreviewScroll(i8)

Persistent single-line vertical scroll 0 to reset.

PreviewJump

Jump between start, end, last, and initial locations. (unimplemented).

SetInput(String)

Set input query

SetHeader(Option<String>)

Set header

SetFooter(Option<String>)

Set footer

SetPrompt(Option<String>)

Set prompt

Column(usize)

Set column

CycleColumn

Cycle columns

ColumnLeft

ColumnRight

ScrollLeft

ScrollRight

Execute(String)

Execute command and continue

Become(String)

Exit and become

Reload(String)

Reload matcher/worker

Print(String)

Print via handler

HistoryUp

History up (TODO)

HistoryDown

History down (TODO)

ChangePrompt

Change prompt (TODO)

ChangeQuery

Change query (TODO)

ForwardChar

Move cursor forward char

BackwardChar

Move cursor backward char

ForwardWord

Move cursor forward word

BackwardWord

Move cursor backward word

DeleteChar

Delete char

DeleteWord

Delete word

DeleteLineStart

Delete to start of line

DeleteLineEnd

Delete to end of line

Cancel

Clear input

InputPos(i32)

Set input cursor pos

Up(u16)

Move selection index up

Down(u16)

Move selection index down

PreviewUp(u16)

Scroll preview up

PreviewDown(u16)

Scroll preview down

PreviewHalfPageUp

Scroll preview half page up

PreviewHalfPageDown

Scroll preview half page down

Pos(i32)

Jump to absolute position

Input(char)

Insert char into input

Redraw

Force redraw

Custom(A)

Custom action

Overlay(usize)

Activate the nth overlay

Trait Implementations

impl<A: Clone + ActionExt> Clone for Action<A>

fn clone(&self) -> Action<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + ActionExt> Debug for Action<A>

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

Formats the value using the given formatter.

impl<A: ActionExt + Display> Display for Action<A>

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

Formats the value using the given formatter.

impl<A: ActionExt> From<&Action<A>> for RenderCommand<A>

fn from(action: &Action<A>) -> Self

Converts to this type from the input type.

impl<A: ActionExt> From<Action<A>> for Actions<A>

fn from(action: Action<A>) -> Self

Converts to this type from the input type.

impl<T> From<T> for Action<T>

where T: ActionExt,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<A: ActionExt + FromStr> FromStr for Action<A>

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<A: PartialEq + ActionExt> PartialEq for Action<A>

fn eq(&self, other: &Action<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: ActionExt + Display> Serialize for Action<A>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<A: ActionExt> StructuralPartialEq for Action<A>