Enum PubsubFrame 

pub enum PubsubFrame {
    Subscribe {
        channel: Vec<u8>,
        count: usize,
    },
    Psubscribe {
        pattern: Vec<u8>,
        count: usize,
    },
    Unsubscribe {
        channel: Option<Vec<u8>>,
        count: usize,
    },
    Punsubscribe {
        pattern: Option<Vec<u8>>,
        count: usize,
    },
    Message {
        channel: Vec<u8>,
        payload: Vec<u8>,
    },
    Pmessage {
        pattern: Vec<u8>,
        channel: Vec<u8>,
        payload: Vec<u8>,
    },
}

One pub/sub event delivered to a Subscription.

Variants

Subscribe

Ack: SUBSCRIBE succeeded on channel.

Fields

channel: Vec<u8>

Channel that was just subscribed.

count: usize

Total channels + patterns this subscription holds after the op.

Psubscribe

Ack: PSUBSCRIBE succeeded on pattern.

Fields

pattern: Vec<u8>

Pattern that was just subscribed.

count: usize

Total channels + patterns this subscription holds after the op.

Unsubscribe

Ack: UNSUBSCRIBE removed channel (or “all”, when None).

Fields

channel: Option<Vec<u8>>

Channel that was just unsubscribed (None = “all”).

count: usize

Total channels + patterns still held after the op.

Punsubscribe

Ack: PUNSUBSCRIBE removed pattern (or “all”, when None).

Fields

pattern: Option<Vec<u8>>

Pattern that was just unsubscribed (None = “all”).

count: usize

Total channels + patterns still held after the op.

Message

A PUBLISH reached a channel this subscription holds directly.

Fields

channel: Vec<u8>

Channel the publish was made to.

payload: Vec<u8>

Raw payload bytes.

Pmessage

A PUBLISH reached a channel matching one of this subscription’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.

Implementations

impl PubsubFrame

pub fn into_payload(self) -> Option<Vec<u8>>

The raw message payload, moved out of the frame.

Some(payload) for the two delivery frames (Message and Pmessage); None for every control/ack frame (subscribe / unsubscribe / …), which carries no payload. Consuming self lets a scalar drain hand a push subscriber just the bytes with no extra copy — the pub/sub analog of the KV scalar door. The channel and the message-vs-pmessage distinction are dropped; a caller that needs either keeps matching on the frame.

Trait Implementations

impl Clone for PubsubFrame

fn clone(&self) -> PubsubFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PubsubFrame

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

Formats the value using the given formatter.

impl Eq for PubsubFrame

impl PartialEq for PubsubFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PubsubFrame