Struct CrosstermEventSource 

pub struct CrosstermEventSource { /* private fields */ }

Production EventSource: reads real terminal input via crossterm. Uses injectable function pointers for poll and read so the two branches of poll_event can be exercised in unit tests without a real TTY. In production, construct via CrosstermEventSource::open. Wired into the real UIs only by the binary.

Implementations

impl CrosstermEventSource

pub fn open() -> Self

Open a source over the real terminal.

Named open rather than new deliberately. A new with no arguments invites a Default impl, and a defaulted event source is one that reads no terminal - which is exactly the thing a test should have to ask for explicitly rather than get by writing ..Default::default().

Trait Implementations

impl EventSource for CrosstermEventSource

fn poll_event(&mut self, timeout: Duration) -> Result<Option<Event>>

Wait up to timeout for one input event. Ok(None) means the timeout elapsed with nothing to read, which is what lets a UI loop tick.