Enum PromptAction 

pub enum PromptAction {
    Abort(bool),
    Submit,
    Recall(RecallFilter, MoveDir1D, Count),
}

Actions for manipulating prompts.

Variants

Abort(bool)

Abort command entry.

bool indicates whether this requires the prompt to be empty. (For example, how <C-D> behaves in shells.)

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, PromptAction};

let act: Action = action!("prompt abort");
let exp: Action = PromptAction::Abort(false).into();
assert_eq!(act, exp);

Submit

Submit the currently entered text.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, PromptAction};

let act: Action = action!("prompt submit");
let exp: Action = PromptAction::Submit.into();
assert_eq!(act, exp);

Recall(RecallFilter, MoveDir1D, Count)

Move backwards and forwards through previous entries.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action, PromptAction};

let filter = RecallFilter::All;
let act: Action = PromptAction::Recall(filter.clone(), MoveDir1D::Next, Count::Contextual).into();

// All of these are equivalent:
assert_eq!(act, action!("prompt recall -d next -c ctx -F all"));
assert_eq!(act, action!("prompt recall -d next -c ctx -F {filter}"));
assert_eq!(act, action!("prompt recall -d next -c ctx"));
assert_eq!(act, action!("prompt recall -d next"));

Trait Implementations

impl Clone for PromptAction

fn clone(&self) -> PromptAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptAction

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

Formats the value using the given formatter.

impl<I: ApplicationInfo> From<PromptAction> for Action<I>

fn from(act: PromptAction) -> Self

Converts to this type from the input type.

impl PartialEq for PromptAction

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

impl StructuralPartialEq for PromptAction