Enum PubsubEvent 

#[non_exhaustive]
pub enum PubsubEvent {
    Subscribe {
        channel: Vec<u8>,
        count: i64,
    },
    Psubscribe {
        pattern: Vec<u8>,
        count: i64,
    },
    Unsubscribe {
        channel: Option<Vec<u8>>,
        count: i64,
    },
    Punsubscribe {
        pattern: Option<Vec<u8>>,
        count: i64,
    },
    Message {
        channel: Vec<u8>,
        payload: Vec<u8>,
    },
    Pmessage {
        pattern: Vec<u8>,
        channel: Vec<u8>,
        payload: Vec<u8>,
    },
}

One pubsub frame received from the server.

Unsubscribe / Punsubscribe’s channel / pattern is None when the server is acknowledging “unsubscribed from everything” with a nil bulk — matching the Redis wire shape.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Subscribe

SUBSCRIBE ack — one per channel the client subscribed to.

Fields

channel: Vec<u8>

Channel that was just subscribed.

count: i64

Total number of channels + patterns the connection is now subscribed to.

Psubscribe

PSUBSCRIBE ack — one per pattern.

Fields

pattern: Vec<u8>

Pattern that was just subscribed.

count: i64

Total number of channels + patterns the connection is now subscribed to.

Unsubscribe

UNSUBSCRIBE ack — channel: None when the server is reporting “no channels were subscribed” (the spec’s nil bulk).

Fields

channel: Option<Vec<u8>>

Channel that was just unsubscribed (None for “all” / “none”).

count: i64

Total number of channels + patterns still subscribed.

Punsubscribe

PUNSUBSCRIBE ack — pattern None when the server is reporting “no patterns were subscribed”.

Fields

pattern: Option<Vec<u8>>

Pattern that was just unsubscribed (None for “all” / “none”).

count: i64

Total number of channels + patterns still subscribed.

Message

Plain PUBLISH delivery on a subscribed channel.

Fields

channel: Vec<u8>

Channel the publish was made to.

payload: Vec<u8>

Raw payload bytes (no encoding assumed).

Pmessage

Pattern-match delivery: a PUBLISH to a channel that matched one of this connection’s patterns.

Fields

pattern: Vec<u8>

Pattern the channel matched.

channel: Vec<u8>

Channel the publish was made to.

payload: Vec<u8>

Raw payload bytes.

Trait Implementations

impl Clone for PubsubEvent

fn clone(&self) -> PubsubEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PubsubEvent

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

Formats the value using the given formatter.

impl Eq for PubsubEvent

impl PartialEq for PubsubEvent

fn eq(&self, other: &PubsubEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PubsubEvent