EventQueue

simploxide_core

Struct EventQueue

pub struct EventQueue { /* private fields */ }

Expand description

An event queue buffers events if you’re not actively processing them so it’s recommended to drop it as soon as it no longer needed.

Implementations§

impl EventQueue

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

Can return a SimpleX event or a tokio_tungstenite::tungstenite::Error if a connection is dropped due to a web socket failure. SimpleX events can themselves represent SimpleX errors but recognizing and handling them them is a task of the upstream code.

pub fn into_receiver(self) -> UnboundedReceiver<Result<Event>>

Get the underlying tokio unbounded receiver that enables more complicated use cases.

Auto Trait Implementations§

impl Freeze for EventQueue

impl RefUnwindSafe for EventQueue

impl Send for EventQueue

impl Sync for EventQueue

impl Unpin for EventQueue

impl UnwindSafe for EventQueue

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V