Struct requestty_ui::Input

pub struct Input<P, B: Backend> { /* private fields */ }

A ui runner which implements the render cycle.

It renders and processes events with the help of a type that implements Prompt.

See run for more information

Implementations

impl<P, B: Backend> Input<P, B>

pub fn new(prompt: P, backend: &mut B) -> Input<P, &mut B>

Creates a new Input. This won’t do anything until it is run.

pub fn hide_cursor(self) -> Self

Hides the cursor while running the input. This won’t do anything until it is run.

pub fn on_esc(self, on_esc: OnEsc) -> Self

What to do after receiving a Esc.

For OnEsc::Terminate - an Error::Aborted will be returned. For OnEsc::SkipQuestion - the currently shown prompt will be cleared, and Ok(None) will be returned. For OnEsc::Ignore - no special behaviour will be applied to the Esc key. Like other keys, the Esc key will be passed to the prompt to handle.

impl<P: Prompt, B: Backend> Input<P, B>

pub fn run<E>(self, events: &mut E) -> Result<Option<P::Output>> where
    E: EventIterator, 

Display the prompt and process events until the user presses Enter.

After the user presses Enter, validate will be called.

Trait Implementations

impl<P: Debug, B: Debug + Backend> Debug for Input<P, B>

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

Formats the value using the given formatter.