Struct Input 

pub struct Input { /* private fields */ }

A text input field.

Implementations

impl Input

pub fn new() -> Self

Creates a new input field.

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

Sets the field key.

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

Sets the initial value.

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

Sets the title.

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

Sets the description.

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

Sets the placeholder text.

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

Sets the prompt string.

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

Sets the character limit.

pub fn echo_mode(self, mode: EchoMode) -> Self

Sets the echo mode.

pub fn password(self, password: bool) -> Self

Sets password mode (shorthand for echo_mode).

pub fn inline(self, inline: bool) -> Self

Sets whether the title and input are on the same line.

pub fn validate(self, validate: fn(&str) -> Option<String>) -> Self

Sets the validation function.

pub fn suggestions(self, suggestions: Vec<String>) -> Self

Sets the suggestions for autocomplete.

pub fn get_string_value(&self) -> &str

Gets the current value.

pub fn id(&self) -> usize

Returns the field ID.

Trait Implementations

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl Field for Input

fn get_key(&self) -> &str

Returns the field’s key.

fn get_value(&self) -> Box<dyn Any>

Returns the field’s value.

fn error(&self) -> Option<&str>

Returns the current validation error, if any.

fn init(&mut self) -> Option<Cmd>

Initializes the field.

fn update(&mut self, msg: &Message) -> Option<Cmd>

Updates the field with a message.

fn view(&self) -> String

Renders the field.

fn focus(&mut self) -> Option<Cmd>

Focuses the field.

fn blur(&mut self) -> Option<Cmd>

Blurs the field.

fn key_binds(&self) -> Vec<Binding>

Returns the help keybindings.

fn with_theme(&mut self, theme: &Theme)

Sets the theme.

fn with_keymap(&mut self, keymap: &KeyMap)

Sets the keymap.

fn with_width(&mut self, width: usize)

Sets the width.

fn with_height(&mut self, height: usize)

Sets the height.

fn with_position(&mut self, position: FieldPosition)

Sets the field position.

fn skip(&self) -> bool

Returns whether this field should be skipped.

fn zoom(&self) -> bool

Returns whether this field should zoom (take full height).