Struct evdev::EventStream

pub struct EventStream { /* private fields */ }

Available on crate feature tokio and Unix only.

An asynchronous stream of input events.

This can be used by calling stream.next_event().await?, or if you need to pass it as a stream somewhere, the futures::Stream implementation. There’s also a lower-level Self::poll_event function if you need to fetch an event from inside a Future::poll impl.

Implementations

impl EventStream

pub fn device(&self) -> &Device

Returns a reference to the underlying device

pub fn device_mut(&mut self) -> &mut Device

Returns a mutable reference to the underlying device

pub async fn next_event(&mut self) -> Result<InputEvent>

Try to wait for the next event in this stream. Any errors are likely to be fatal, i.e. any calls afterwards will likely error as well.

pub fn poll_event(&mut self, cx: &mut Context<'_>) -> Poll<Result<InputEvent>>

A lower-level function for directly polling this stream.

Trait Implementations

impl Stream for EventStream

type Item = Result<InputEvent, 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.

impl Unpin for EventStream