Struct PubsubClientSubscription

source

pub struct PubsubClientSubscription<T>where
    T: DeserializeOwned,
{ /* private fields */ }

Expand description

A subscription.

The subscription is unsubscribed on drop, and note that unsubscription (and thus drop) time is unbounded. See PubsubClientSubscription::send_unsubscribe.

Implementations§

source §

impl<T> PubsubClientSubscription<T>
where T: DeserializeOwned,

source

pub fn send_unsubscribe(&self) -> Result<(), PubsubClientError>

Send an unsubscribe message to the server.

Note that this will block as long as the internal subscription receiver is waiting on messages from the server, and this can take an unbounded amount of time if the server does not send any messages.

If a pubsub client needs to shutdown reliably it should use the async client in crate::nonblocking::pubsub_client.

source

pub fn shutdown(&mut self) -> Result<(), Box<dyn Any + Send>>

Shutdown the internel message receiver and wait for its thread to exit.

Note that this will block as long as the subscription receiver is waiting on messages from the server, and this can take an unbounded amount of time if the server does not send any messages.

If a pubsub client needs to shutdown reliably it should use the async client in crate::nonblocking::pubsub_client.

Trait Implementations§

source §

impl<T> Drop for PubsubClientSubscription<T>
where T: DeserializeOwned,

source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> !UnwindSafe for PubsubClientSubscription<T>

Blanket Implementations§

source §

impl<T> AbiExample for T

source §

default fn example() -> T

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source §

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source §

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source §

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> Instrument for T

source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into 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> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §