Struct requestty_ui::widgets::StringInput

pub struct StringInput<F = FilterMapChar> { /* fields omitted */ }

A widget that inputs a string.

A filter_map function can optionally be provided to limit and change the characters allowed, similar to Iterator::filter_map.

If only a single character is required, use CharInput.

Implementations

impl StringInput

pub fn new() -> Self

Creates a new StringInput which accepts all characters.

impl<F> StringInput<F>

pub fn with_filter_map(filter_map: F) -> Self

Creates a new StringInput which only accepts characters as per the filter_map function.

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

A mask to render instead of the actual characters.

This is useful for passwords.

pub fn hide_output(self) -> Self

Hide the value being entered, and render nothing.

This is useful for passwords.

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

A helper that sets mask if mask is some, otherwise hides the output

pub fn get_at(&self) -> usize

Gets the location of the ‘cursor’ in characters.

pub fn set_at(&mut self, at: usize)

Sets the location of the ‘cursor’ in characters.

pub fn value(&self) -> &str

The value of the StringInput

pub fn set_value(&mut self, value: String)

Sets the value

pub fn replace_with<W: FnOnce(String) -> String>(&mut self, with: W)

Replaces the value with the result of the function

pub fn has_value(&self) -> bool

Check whether any character has come to the input.

This does not check if the string is empty. So a character is added, and then deleted, it has_value will return true.

pub fn finish(self) -> Option<String>

Returns None if no characters have been inputted, otherwise returns Some(_).

It can return Some(""), if a character was added and then deleted. It will only return None when no character was ever received.

Trait Implementations

impl<F: Clone> Clone for StringInput<F>

fn clone(&self) -> StringInput<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for StringInput<F>

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

Formats the value using the given formatter.

impl Default for StringInput

fn default() -> Self

Returns the “default value” for a type.

impl<F> Widget for StringInput<F> where
    F: Fn(char) -> Option<char>, 

fn render<B: Backend>(
    &mut self,
    layout: &mut Layout,
    backend: &mut B
) -> Result<()>

This widget ignores layout.offset_x and wraps around in the terminal.

fn handle_key(&mut self, key: KeyEvent) -> bool

Handle a key input. It should return whether key was handled.

fn height(&mut self, layout: &mut Layout) -> u16

The number of rows of the terminal the widget will take when rendered.

fn cursor_pos(&mut self, layout: Layout) -> (u16, u16)

The position of the cursor to be placed at after render. The returned value should be in the form of (x, y), with (0, 0) being the top left of the screen.