Struct embedded_redis::subscription::Subscription

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 */ }

Client for handling subscriptions

L: Number of subscribed topics

Implementations

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,

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

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

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

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

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,

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

Formats the value using the given formatter.

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,

fn drop(&mut self)

Executes the destructor for this type.