Struct Input

Source
pub struct Input<F = fn(char) -> bool, C = NonCancellable> { /* private fields */ }

Implementations§

Source§

impl<F> Input<F>
where F: FnMut(char) -> bool,

Source

pub fn new(config: Config<'_, F>) -> Result<Self, Error>

Source§

impl<F, C> Input<F, C>
where F: FnMut(char) -> bool, C: Cancellation<String>,

Source

pub fn from_cancellation( config: Config<'_, F>, cancellation: C, ) -> Result<Self, Error>

Source

pub fn with_title(self, title: &str) -> Self

Source

pub fn set_title(&mut self, title: &str) -> &mut Self

Source

pub fn with_cancellation(self, cancellation: C) -> Self

Source

pub fn set_cancellation(&mut self, cancellation: C) -> &mut Self

Source

pub fn with_max(self, max: Coord) -> Result<Self, Error>

Source

pub fn set_max(&mut self, max: Coord) -> Result<&mut Self, Error>

Source

pub fn with_style(self, style: Style) -> Self

Source

pub fn set_style(&mut self, style: Style) -> &mut Self

Source

pub fn with_buffer<I>(self, chars: I) -> Result<Self, usize>
where I: IntoIterator<Item = char>,

Source

pub fn set_buffer<I>(&mut self, chars: I) -> Result<&mut Self, usize>
where I: IntoIterator<Item = char>,

Source

pub fn style(&self) -> &Style

Source

pub fn key_bindings(&self) -> &KeyBindingMap

Source

pub fn cancellation(&self) -> &C

Source

pub fn is_cancellable(&self) -> bool

Source

pub fn is_cancelling(&self) -> bool

Source

pub fn set_cancelling(&mut self, is_it: bool)

Source

pub fn finish_buffer(&self) -> String

Source

pub fn output(&self) -> C::Output

Source

pub fn insert_char(&mut self, char: char)

Source

pub fn delete_behind(&mut self)

Source

pub fn delete_ahead(&mut self)

Source

pub fn insert_chars<I>(&mut self, chars: I) -> Result<(), usize>
where I: IntoIterator<Item = char>,

Source

pub fn move_left(&mut self)

Source

pub fn move_right(&mut self)

Source

pub fn title(&self) -> &str

Source

pub fn max(&self) -> Coord

Source

pub fn len(&self) -> Coord

Source

pub fn cursor(&self) -> Coord

Source

pub fn set_cursor(&mut self, position: Coord) -> Result<(), Coord>

Source

pub fn clear_buffer(&mut self)

Source

pub fn run_command(&mut self, cmd: Command) -> Result<bool, Error>

Source

pub async fn run(&mut self, app: &mut App) -> Result<(), Error>

Trait Implementations§

Source§

impl<F: Clone, C: Clone> Clone for Input<F, C>

Source§

fn clone(&self) -> Input<F, C>

Returns a copy 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<F: Debug, C: Debug> Debug for Input<F, C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F, C> Freeze for Input<F, C>
where F: Freeze, C: Freeze,

§

impl<F, C> RefUnwindSafe for Input<F, C>

§

impl<F, C> Send for Input<F, C>
where F: Send, C: Send,

§

impl<F, C> Sync for Input<F, C>
where F: Sync, C: Sync,

§

impl<F, C> Unpin for Input<F, C>
where F: Unpin, C: Unpin,

§

impl<F, C> UnwindSafe for Input<F, C>
where F: UnwindSafe, C: UnwindSafe,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more