Enum ProtocolVersion 

#[repr(u8)]
pub enum ProtocolVersion {
    V1 = 1,
    V2 = 2,
}

Protocol version negotiated per-connection.

• V1 (default): Pusher-compatible. Uses pusher: / pusher_internal: prefixes. Features like serial, message_id, and recovery are opt-in via server config.
• V2: Sockudo-native. Uses sockudo: / sockudo_internal: prefixes. Serial, message_id, and connection recovery are always enabled.

Variants

V1 = 1

V2 = 2

Implementations

impl ProtocolVersion

pub fn from_query_param(value: Option<u8>) -> Self

Parse from the ?protocol= query parameter value. Returns V1 for unrecognized values.

pub const fn event_prefix(&self) -> &'static str

Event prefix for this protocol version (e.g. "pusher:" or "sockudo:").

pub const fn internal_prefix(&self) -> &'static str

Internal event prefix (e.g. "pusher_internal:" or "sockudo_internal:").

pub const fn is_serial_native(&self) -> bool

Whether serial numbers are native (always-on) for this protocol version.

pub const fn is_message_id_native(&self) -> bool

Whether message_id is native (always-on) for this protocol version.

pub const fn is_recovery_native(&self) -> bool

Whether connection recovery is native (always-on) for this protocol version.

pub fn wire_event(&self, canonical: &str) -> String

Build a wire-format event name from a canonical name. E.g. "subscribe" → "pusher:subscribe" or "sockudo:subscribe".

pub fn wire_internal_event(&self, canonical: &str) -> String

Build a wire-format internal event name from a canonical name. E.g. "subscription_succeeded" → "pusher_internal:subscription_succeeded".

pub fn parse_event_name<'a>(&self, wire: &'a str) -> Option<&'a str>

Strip the protocol prefix from a wire-format event name, returning the canonical name. Returns None if the event doesn’t match this version’s prefix.

pub fn parse_any_protocol_event(wire: &str) -> Option<(&str, bool)>

Determine if a wire event name belongs to ANY known protocol version, returning the canonical name and whether it’s internal.

pub fn rewrite_event_prefix(&self, event: &str) -> String

Rewrite a pusher: or pusher_internal: event name to this version’s prefix. If the event doesn’t have a known prefix, returns it unchanged.

Trait Implementations

impl Clone for ProtocolVersion

fn clone(&self) -> ProtocolVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolVersion

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

Formats the value using the given formatter.

impl Default for ProtocolVersion

fn default() -> ProtocolVersion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtocolVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProtocolVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProtocolVersion

fn eq(&self, other: &ProtocolVersion) -> 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 Serialize for ProtocolVersion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ProtocolVersion

impl Eq for ProtocolVersion

impl StructuralPartialEq for ProtocolVersion