Skip to main content

PromptAction

Enum PromptAction 

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

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§

Source§

impl Clone for PromptAction

Source§

fn clone(&self) -> PromptAction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptAction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PromptAction

Source§

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

Source§

fn from(act: PromptAction) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for PromptAction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PromptAction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.