Skip to main content

Subscription

Struct Subscription 

Source
pub struct Subscription<Notif> { /* private fields */ }
Expand description

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§

Source§

impl<Notif> Subscription<Notif>

Source

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

Create a new subscription.

Source§

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

Source

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§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Notif> Drop for Subscription<Notif>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<Notif> !RefUnwindSafe for Subscription<Notif>

§

impl<Notif> !UnwindSafe for Subscription<Notif>

§

impl<Notif> Freeze for Subscription<Notif>

§

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

§

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

§

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

§

impl<Notif> UnsafeUnpin for Subscription<Notif>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

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

Source§

fn vzip(self) -> V