Enum Event 

pub enum Event {
    Cancel {
        selected: Option<usize>,
    },
    Ok {
        alt: bool,
        selected: usize,
    },
    CustomInput {
        alt: bool,
        selected: Option<usize>,
    },
    Complete {
        selected: Option<usize>,
    },
    DeleteEntry {
        selected: usize,
    },
    CustomCommand {
        number: u8,
        selected: Option<usize>,
    },
}

An event triggered by the user.

Variants

Cancel

The user cancelled the operation, for example by pressing escape.

Fields

selected: Option<usize>

The index of the line that was selected at the time of cancellation, if one was selected.

If present, this will be < Mode::entries.

Ok

The user accepted an option from the list (ctrl+j, ctrl+m or enter by default).

Fields

alt: bool

Whether the alt binding was used (shift+enter by default).

selected: usize

The line that was selected.

CustomInput

The user entered an input not on the list (ctrl+return by default).

Fields

alt: bool

Whether the alt binding was used (ctrl+shift+return by default).

selected: Option<usize>

The index of the line that was selected at the time of the event, if one was selected.

If present, this will be < Mode::entries.

Complete

The user used the kb-mode-complete binding (control+l by default).

If this happens, you should set the input value to the currently selected entry if there is one.

Fields

selected: Option<usize>

The index of the line that was selected at the time of the event, if one was selected.

If present, this will be < Mode::entries.

DeleteEntry

The user used the kb-delete-entry binding (shift+delete by default).

Fields

selected: usize

The index of the entry that was selected to be deleted.

If present, this will be < Mode::entries.

CustomCommand

The user ran a custom command.

Fields

number: u8

The number of the custom command, in the range [0, 18].

selected: Option<usize>

The index of the line that was selected at the time of the event, if one was selected.

If present, this will be < Mode::entries.

Implementations

impl Event

pub const fn selected(&self) -> Option<usize>

Get the index of the line that was selected at the time of the event, if one was selected.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl PartialEq for Event

fn eq(&self, other: &Event) -> 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 Copy for Event

impl Eq for Event

impl StructuralPartialEq for Event