embedded_redis::subscription

Struct Subscription

Source 
pub struct Subscription<'a, N: TcpClientStack, C: Clock, P: Protocol, const L: usize>
where
    HelloCommand: Command<<P as Protocol>::FrameType>,
    <P as Protocol>::FrameType: From<CommandBuilder> + ToPushMessage,
{ /* private fields */ }
Expand description

Client for handling subscriptions

L: Number of subscribed topics

Implementations§

Source§

impl<'a, N, C, P, const L: usize> Subscription<'a, N, C, P, L>
where N: TcpClientStack, C: Clock, P: Protocol, HelloCommand: Command<<P as Protocol>::FrameType>, <P as Protocol>::FrameType: From<CommandBuilder> + ToPushMessage,

Source

pub fn new(client: Client<'a, N, C, P>, topics: [Bytes; L]) -> Self

Source

pub fn receive(&mut self) -> Result<Option<Message>, Error>

Receives a message. Returns None in case no message is pending

Source

pub fn unsubscribe(self) -> Result<(), Error>

Unsubscribes from all topics and waits for confirmation

If this fails, it’s recommended to clos the connection to avoid subsequent errors caused by invalid state

Trait Implementations§

Source§

impl<'a, N: Debug + TcpClientStack, C: Debug + Clock, P: Debug + Protocol, const L: usize> Debug for Subscription<'a, N, C, P, L>
where HelloCommand: Command<<P as Protocol>::FrameType>, <P as Protocol>::FrameType: From<CommandBuilder> + ToPushMessage,

Source§

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

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

impl<N, C, P, const L: usize> Drop for Subscription<'_, N, C, P, L>
where N: TcpClientStack, C: Clock, P: Protocol, HelloCommand: Command<<P as Protocol>::FrameType>, <P as Protocol>::FrameType: From<CommandBuilder> + ToPushMessage,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, N, C, P, const L: usize> !Freeze for Subscription<'a, N, C, P, L>

§

impl<'a, N, C, P, const L: usize> !RefUnwindSafe for Subscription<'a, N, C, P, L>

§

impl<'a, N, C, P, const L: usize> !Send for Subscription<'a, N, C, P, L>

§

impl<'a, N, C, P, const L: usize> !Sync for Subscription<'a, N, C, P, L>

§

impl<'a, N, C, P, const L: usize> Unpin for Subscription<'a, N, C, P, L>
where <P as Protocol>::FrameType: Sized + Unpin, P: Unpin,

§

impl<'a, N, C, P, const L: usize> !UnwindSafe for Subscription<'a, N, C, P, L>

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

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.