Skip to main content

ChannelConfig

Struct ChannelConfig 

Source
pub struct ChannelConfig {
    pub channel_id: ChannelId,
    pub visibility: Visibility,
    pub publish_caps: Option<CapabilityFilter>,
    pub subscribe_caps: Option<CapabilityFilter>,
    pub require_token: bool,
    pub priority: u8,
    pub reliable: bool,
    pub max_rate_pps: Option<u32>,
}
Expand description

Channel configuration with capability-based access control.

Authorization flow:

  1. Node announces capabilities via CapabilityAd
  2. If publish_caps is set, node’s CapabilitySet must match the filter
  3. If require_token is true, node must also have a valid PermissionToken
  4. On success, (origin_hash, channel_hash) is inserted into the AuthGuard

Fields§

§channel_id: ChannelId

Channel identity (name + hash).

§visibility: Visibility

Visibility scope for subnet routing.

§publish_caps: Option<CapabilityFilter>

Capability requirements for publishing. None = any node can publish.

§subscribe_caps: Option<CapabilityFilter>

Capability requirements for subscribing. None = any node can subscribe.

§require_token: bool

Whether a valid PermissionToken is required (in addition to capabilities).

§priority: u8

Default priority level for this channel’s packets (0 = lowest).

§reliable: bool

Default reliability mode for streams on this channel.

§max_rate_pps: Option<u32>

Optional rate limit in packets per second.

Implementations§

Source§

impl ChannelConfig

Source

pub fn new(channel_id: ChannelId) -> ChannelConfig

Create a new channel config with defaults (open access, global visibility).

Source

pub fn with_visibility(self, visibility: Visibility) -> ChannelConfig

Set visibility.

Source

pub fn with_publish_caps(self, filter: CapabilityFilter) -> ChannelConfig

Set capability requirements for publishing.

Source

pub fn with_subscribe_caps(self, filter: CapabilityFilter) -> ChannelConfig

Set capability requirements for subscribing.

Source

pub fn with_require_token(self, require: bool) -> ChannelConfig

Require a valid permission token.

Source

pub fn with_priority(self, priority: u8) -> ChannelConfig

Set default priority.

Source

pub fn with_reliable(self, reliable: bool) -> ChannelConfig

Set default reliability.

Source

pub fn with_rate_limit(self, pps: u32) -> ChannelConfig

Set rate limit.

Source

pub fn can_publish( &self, node_caps: &CapabilitySet, entity_id: &EntityId, token_cache: &TokenCache, ) -> bool

Check if a node is authorized to publish on this channel.

Source

pub fn can_subscribe( &self, node_caps: &CapabilitySet, entity_id: &EntityId, token_cache: &TokenCache, ) -> bool

Check if a node is authorized to subscribe to this channel.

Trait Implementations§

Source§

impl Clone for ChannelConfig

Source§

fn clone(&self) -> ChannelConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChannelConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more