Struct crossterm::event::EventStream

pub struct EventStream { /* private fields */ }

A stream of Result<Event>.

This type is not available by default. You have to use the event-stream feature flag to make it available.

It implements the Stream trait and allows you to receive Events with async-std or tokio crates.

Check the examples folder to see how to use it (event-stream-*).

Implementations

impl EventStream

pub fn new() -> EventStream

Constructs a new instance of EventStream.

Trait Implementations

impl Debug for EventStream

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

Formats the value using the given formatter.

impl Default for EventStream

fn default() -> Self

Returns the “default value” for a type.

impl Drop for EventStream

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for EventStream

type Item = Result<Event, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.