Prompt

Struct Prompt 

Source
pub struct Prompt { /* private fields */ }
Expand description

A Mode for the PromptLine

This mode abstracts over what the inner PromptMode actually does, by letting them focus on just updating the Text and acting on user input, instead of having to worry about which keys do what, and when to update.

There are currently three PromptModes:

  • RunCommands is just your regular command runner, it can also detect if your Parameters are correct and show that in real time.
  • PipeSelections pipes each Selection’s selection in the current Buffer to an external application, replacing each selection with the returned value.
  • IncSearch has a further inner abstraction, IncSearcher, which lets you abstract over what the incremental search will actually do. I.c. will it search for the next ocurrence, split selections by matches, things of the sort.

Implementations§

Source§

impl Prompt

Source

pub fn new<M: PromptMode + Clone>(mode: M) -> Self

Returns a new Prompt from this PromptMode

For convenience, you should make it so new methods in PromptMode implementors return a Prompt<Self>, rather than the PromptMode itself.

Source

pub fn new_with<M: PromptMode + Clone>(mode: M, initial: impl ToString) -> Self

Returns a new Prompt with some initial text

This is useful if you wish to open this Mode with some text already in it.

Trait Implementations§

Source§

impl Clone for Prompt

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Mode for Prompt

Source§

type Widget = PromptLine

The Widget that this Mode controls
Source§

fn bindings() -> Bindings

A list of all available keybindings for this Mode Read more
Source§

fn send_key( &mut self, pa: &mut Pass, key: KeyEvent, handle: Handle<Self::Widget>, )

Sends a KeyEvent to this Mode
Source§

fn on_switch(&mut self, pa: &mut Pass, handle: Handle<Self::Widget>)

A function to trigger after switching to this Mode Read more
Source§

fn before_exit(&mut self, pa: &mut Pass, handle: Handle<Self::Widget>)

A function to trigger before switching off this Mode Read more

Auto Trait Implementations§

§

impl Freeze for Prompt

§

impl !RefUnwindSafe for Prompt

§

impl Send for Prompt

§

impl !Sync for Prompt

§

impl Unpin for Prompt

§

impl !UnwindSafe for Prompt

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
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.