Struct Input 

pub struct Input { /* private fields */ }

The input buffer with cursor support.

Example:

use tui_input::Input;

let input: Input = "Hello World".into();

assert_eq!(input.cursor(), 11);
assert_eq!(input.to_string(), "Hello World");

Implementations

impl Input

pub fn new(value: String) -> Self

Initialize a new instance with a given value Cursor will be set to the given value’s length.

pub fn with_value(self, value: String) -> Self

Set the value manually. Cursor will be set to the given value’s length.

pub fn with_cursor(self, cursor: usize) -> Self

Set the cursor manually. If the input is larger than the value length, it’ll be auto adjusted.

pub fn reset(&mut self)

pub fn value_and_reset(&mut self) -> String

pub fn handle(&mut self, req: InputRequest) -> InputResponse

Handle request and emit response.

pub fn value(&self) -> &str

Get a reference to the current value.

pub fn cursor(&self) -> usize

Returns the number of codepoints preceding the cursor. Movement and deletion operations step one grapheme at a time, so a single InputRequest::GoToNextChar or InputRequest::DeletePrevChar may change this count by more than one.

pub fn visual_cursor(&self) -> usize

Returns the cursor’s position in display columns (per unicode-width).

pub fn visual_scroll(&self, width: usize) -> usize

Get the scroll position with account for multispace characters.

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 Debug for Input

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

Formats the value using the given formatter.

impl Default for Input

fn default() -> Input

Returns the “default value” for a type.

impl Display for Input

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

Formats the value using the given formatter.

impl EventHandler for Input

fn handle_event(&mut self, evt: &CrosstermEvent) -> Option<StateChanged>

Handle crossterm event.

impl From<&str> for Input

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Input> for String

fn from(input: Input) -> Self

Converts to this type from the input type.

impl From<String> for Input

fn from(value: String) -> Self

Converts to this type from the input type.