Struct xo_api_client::Subscription

pub struct Subscription<Notif> { /* fields omitted */ }

Active subscription on the client.

It will automatically unsubscribe in the Subscription::drop so no need to explicitly call the unsubscribe method if it is an an subscription based on [SubscriptionId].

Implementations

impl<Notif> Subscription<Notif>

pub fn new(
    to_back: Sender<FrontToBack>,
    notifs_rx: Receiver<Value>,
    kind: SubscriptionKind
) -> Subscription<Notif>

Create a new subscription.

impl<Notif> Subscription<Notif> where
    Notif: DeserializeOwned, 

pub async fn next(&'_ mut self) -> Result<Option<Notif>, Error>

Returns the next notification from the stream. This may return Ok(None) if the subscription has been terminated, may happen if the channel becomes full or is dropped.

Trait Implementations

impl<Notif> Debug for Subscription<Notif> where
    Notif: Debug, 

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

Formats the value using the given formatter.

impl<Notif> Drop for Subscription<Notif>

pub fn drop(&mut self)

Executes the destructor for this type.