Enum SystemOp 

#[non_exhaustive]
pub enum SystemOp<C>
where
    C: ChannelKind,
{
    Auth {
        client_id: Uuid,
        token: Option<String>,
        capabilities: Vec<C>,
        resume_cursor: Option<u64>,
        resume_cursors: HashMap<C, u64>,
    },
    AuthOk {
        resume_cursor: u64,
        resume_cursors: HashMap<C, u64>,
    },
    Error {
        message: String,
    },
    Ping,
    Pong,
    Slow {
        window: Option<u32>,
    },
    Ack {
        channel: C,
        cursor: u64,
    },
    ResumeRequired {
        channel: C,
        from_cursor: u64,
    },
    Subscribe {
        channels: Vec<C>,
    },
    Unsubscribe {
        channels: Vec<C>,
    },
    Health {
        status: String,
        detail: Option<String>,
    },
    Features {
        supported: Vec<String>,
        requested: Vec<String>,
    },
    Goodbye {
        reason: Option<String>,
    },
}

System control plane messages that travel on the system channel.

Parameterized by C: ChannelKind so that channel references in Auth, Ack, Subscribe, etc. use the caller’s channel type.

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.

Auth

Fields

client_id: Uuid

token: Option<String>

capabilities: Vec<C>

resume_cursor: Option<u64>

resume_cursors: HashMap<C, u64>

AuthOk

Fields

resume_cursor: u64

resume_cursors: HashMap<C, u64>

Error

Fields

message: String

Ping

Pong

Slow

Fields

window: Option<u32>

Ack

Fields

channel: C

cursor: u64

ResumeRequired

Fields

channel: C

from_cursor: u64

Subscribe

Fields

channels: Vec<C>

Unsubscribe

Fields

channels: Vec<C>

Health

Fields

status: String

detail: Option<String>

Features

Fields

supported: Vec<String>

requested: Vec<String>

Goodbye

Fields

reason: Option<String>

Implementations

impl<C> SystemOp<C>

where C: ChannelKind,

pub fn auth_ok(resume_cursor: u64) -> SystemOp<C>

Trait Implementations

impl<C> Clone for SystemOp<C>

where C: Clone + ChannelKind,

fn clone(&self) -> SystemOp<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for SystemOp<C>

where C: Debug + ChannelKind,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for SystemOp<C>

where C: ChannelKind,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SystemOp<C>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Serialize for SystemOp<C>

where C: ChannelKind,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.