Struct requestty_ui::widgets::CharInput

pub struct CharInput<F = FilterMapChar> { /* private fields */ }

A widget that inputs a single character.

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

If multiple characters are received, they will overwrite the previous character. If a multi-character string is required, use StringInput.

Implementations

impl CharInput

pub fn new() -> Self

Creates a new CharInput which accepts all characters.

impl<F> CharInput<F> where
    F: Fn(char) -> Option<char>, 

pub fn with_filter_map(filter_map: F) -> Self

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

pub fn value(&self) -> Option<char>

The last inputted char (if any).

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

Sets the value to the given character.

pub fn clear_value(&mut self)

Clears the value.

Trait Implementations

impl<F: Clone> Clone for CharInput<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for CharInput<F>

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

Formats the value using the given formatter.

impl Default for CharInput

fn default() -> Self

Returns the “default value” for a type.

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

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

Returns the position right after the character if any.

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

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

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

Render to a given backend.

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

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