Struct Events 

pub struct Events { /* private fields */ }

Helper struct to read from crossterm’s input events

Implementations

impl Events

pub fn from_config(config: Config) -> Events

Creates an Events instance from Config and starts a thread to listen on crossterm input events

pub fn next(&self) -> Result<Option<Event>, RecvError>

Checks if there was a new event to read from. Returns Some(Event) if there was some, None if not and Result::Err if the connection was disconnected.

Examples found in repository

examples/command/main.rs (line 32)

fn handle_input(tui: &mut TuiClap, events: &Events) {
    if let Ok(Some(Event::Key(key_event))) = events.next() {
        match key_event.code {
            KeyCode::Backspace => {
                tui.state().del_char()
            }
            KeyCode::Enter => {
                if let Ok(matches) = tui.parse() {
                    match handle_matches(matches) {
                        Ok(output) => {
                            for message in output {
                                tui.write_to_output(message)
                            }
                        }
                        Err(err) => tui.write_to_output(err)
                    }
                }
            }
            KeyCode::Char(char) => {
                tui.state().add_char(char)
            },
            _ => {}
        }
    }
}

pub fn disable_exit_key(&mut self)

pub fn enable_exit_key(&mut self)

Trait Implementations

impl Default for Events

fn default() -> Self

Returns the “default value” for a type.