Struct ChannelDefinition 

pub struct ChannelDefinition {
    pub channel: String,
    pub auth: Option<AuthRule>,
    pub rooms: bool,
    pub hooks: Option<ChannelHooks>,
}

Definition of a WebSocket channel, parsed from a .channel.yaml file.

channel: notifications
auth: [member, admin]
rooms: true
hooks:
  on_connect: [log_connect]
  on_disconnect: [log_disconnect]
  on_message: [validate_message]

Fields

channel: String

Channel name (e.g., “notifications”).

auth: Option<AuthRule>

Authentication rule for connecting to this channel.

rooms: bool

Whether this channel supports room subscriptions.

hooks: Option<ChannelHooks>

Lifecycle hook configuration.

Trait Implementations

impl Clone for ChannelDefinition

fn clone(&self) -> ChannelDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChannelDefinition

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChannelDefinition