pub struct PushEventReceiver(pub Receiver<Event>);
Expand description

Receiver end of the device-sent event queue.

Owner of the receiver can regularly attempt to pop events from the queue, and decide how to handle an returned event(s).

Example:

let stop_polling = Arc::new(AtomicBool::new(false));
let poll_mode = ssp_server::PollMode::Interactive;

let mut handle = ssp_server::DeviceHandle::new("/dev/ttyUSB0")?;

let rx: ssp_server::PushEventReceiver = handle.start_background_polling_with_queue(
    Arc::clone(&stop_polling),
    poll_mode,
)?;

// Pop events from the queue
loop {
    while let Ok(event) = rx.pop_event() {
        log::debug!("Received an event: {event}");
        // do stuff in response to the event...
    }
}

Tuple Fields§

§0: Receiver<Event>

Implementations§

source§

impl PushEventReceiver

source

pub fn new(queue: Receiver<Event>) -> Self

Creates a new PushEventReceiver from the provided queue.

source

pub fn pop_event(&self) -> Result<Event>

Attempt to pop an event from the queue.

Returns Err(_) if an event could not be retrieved before the timeout.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V