Struct Input 

pub struct Input { /* private fields */ }

Holds the chars typed by the user and the cursor position. Methods allow mutation of this content and movement of the cursor.

Implementations

impl Input

pub fn reset(&mut self)

Empty the content and move the cursor to start.

pub fn index(&self) -> usize

Current index of the cursor

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn string(&self) -> String

Returns the content typed by the user as a String.

pub fn display_index(&self, available_space: usize) -> usize

Index on screen of the cursor. It’s the index minus the left index considering the available space.

pub fn scrolled_string(&self, available_space: usize) -> String

Returns the displayable input as a string accounting for available space. If the text is short enough to be displayed completely it’s the string it self.

pub fn password(&self) -> String

Returns a string of * for every char typed.

pub fn insert(&mut self, c: char)

Insert an utf-8 char into the input at cursor index.

pub fn insert_string(&mut self, pasted: &str)

Insert a pasted string at current position.

pub fn cursor_start(&mut self)

Move the cursor to the start

pub fn cursor_end(&mut self)

Move the cursor to the end

pub fn cursor_left(&mut self)

Move the cursor left if possible

pub fn cursor_right(&mut self)

Move the cursor right if possible

pub fn cursor_move(&mut self, index: usize)

Move the cursor to the given index, limited to the length of the input.

Used when the user click on the input string.

pub fn delete_char_left(&mut self)

Backspace, delete the char under the cursor and move left

pub fn delete_chars_right(&mut self)

Delete all chars right to the cursor

pub fn delete_line(&mut self)

pub fn delete_left(&mut self)

Deletes left symbols until a word is reached or the start of the line A word is delimited by a “separator” \t/\.,;!?%_-+*(){}[]

pub fn replace(&mut self, content: &str)

Replace the content with the new content. Put the cursor at the end.

To avoid splitting graphemes at wrong place, the new content is read as Unicode Graphemes with

unicode_segmentation::UnicodeSegmentation::graphemes(content, true)

See UnicodeSegmentation for more information.

pub fn next_word(&mut self)

Move the cursor to the previous “word”. A word is delimited by a “separator” \t/\.,;!?%_-+*(){}[]

pub fn previous_word(&mut self)

Move the cursor to the previous “word”. A word is delimited by a “separator” \t/\.,;!?%_-+*(){}[]

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Input

fn default() -> Input

Returns the “default value” for a type.