Struct Input 

pub struct Input { /* private fields */ }

One line of text.

Implementations

impl Input

pub fn new(prompt: impl Into<String>) -> Input

pub fn masked(prompt: impl Into<String>) -> Input

A masked input, for passwords and tokens: what is typed shows as •, and a default only as (default set).

pub fn mask(self, mask: char) -> Self

pub fn value(self, value: impl Into<String>) -> Self

Start with this text.

pub fn rebind(self, action: &str, keys: impl IntoIterator<Item = Key>) -> Self

Make keys do action (see input_keymap) on this input only; no keys unbinds it.

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Dim text shown while the line is empty.

pub fn default(self, default: impl Into<String>) -> Self

The answer when Enter is pressed on an empty line, and without a terminal when the policy asks for defaults.

pub fn help(self, help: impl Into<String>) -> Self

A line of help under the input.

pub fn validate( self, validator: impl Fn(&str) -> Result<(), String> + 'static, ) -> Self

Check the answer on Enter; an Err message shows under the line.

pub fn history<I: IntoIterator<Item = S>, S: Into<String>>( self, history: I, ) -> Self

Earlier answers, oldest first, for Up and Down.

pub fn suggestions<I: IntoIterator<Item = S>, S: Into<Suggestion>>( self, suggestions: I, ) -> Self

Fixed suggestions, filtered by what is typed.

pub fn provider( self, provider: impl Fn(&str) -> Vec<Suggestion> + Send + Sync + 'static, ) -> Self

Suggestions from provider, called on a background thread after each change; results for text since changed are dropped.

pub fn limit(self, rows: usize) -> Self

Show at most rows suggestions (default 5).

pub fn theme(self, theme: Theme) -> Self

pub fn text(&self) -> &str

The text typed so far.

pub fn buffer(&self) -> &TextBuffer

The line being edited.

pub fn resolve(&self) -> Result<String, String>

The answer Enter would give: the text, or the default when empty, checked by the validator.

pub fn field(&self, available: usize) -> (Vec<Segment>, usize)

The line’s text as shown (masked, or the placeholder) in available cells, scrolled to keep the caret in view, and the caret’s column in it.

pub fn label(&self) -> &str

The prompt.

pub fn suggesting(&self) -> bool

Whether suggestions are showing: Tab, Up, Down and Enter (with one selected) are theirs.

pub fn has_selection(&self) -> bool

Whether Enter would accept a selected suggestion rather than submit.

pub fn accept_selected(&mut self)

Accept the selected suggestion, as Enter does before submitting.

pub fn suggestion_rows(&self, width: usize, indent: &str) -> Vec<Vec<Segment>>

The suggestion rows (or a pending marker), each after indent.

pub fn display_value(&self, value: &str) -> String

value as this input shows it: masked, for a masked input.

Trait Implementations

impl Component for Input

type Output = String

fn handle(&mut self, event: &Event, _: &Context<'_>) -> Flow<String>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn default_value(&self) -> Option<String>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<String>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

fn start(&mut self, context: &Context<'_>) -> Flow<Self::Output>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.