Struct TokenScope 

pub struct TokenScope { /* private fields */ }

Actions a token can authorize.

Implementations

impl TokenScope

pub const NONE: TokenScope

No permissions.

pub const PUBLISH: TokenScope

Publish events to a channel.

pub const SUBSCRIBE: TokenScope

Subscribe to events from a channel.

pub const ADMIN: TokenScope

Administrative access (create/delete channels, manage tokens).

pub const DELEGATE: TokenScope

Can delegate this token to other entities.

pub const WILDCARD: TokenScope

Wildcard over channels: authorizes the token’s actions on every channel, regardless of the token’s channel_hash field. Must be set explicitly by the issuer — the previous “channel_hash == 0 means wildcard” overload is no longer honored, so a legitimate channel whose xxh3-truncated ChannelHash happens to hash to 0 cannot accidentally be authorized as a universal grant.

pub const ALL: TokenScope

Full access (all actions on a single channel). Does NOT include Self::WILDCARD — callers that want cross-channel access must opt in explicitly.

pub const fn from_bits(bits: u32) -> TokenScope

Create a scope from raw bits.

pub const fn bits(self) -> u32

Get the raw bits.

pub const fn contains(self, other: TokenScope) -> bool

Check if this scope includes another.

A scope never “contains” NONE: the bit-mask identity (self.bits & 0) == 0 would otherwise return true for every token, so a caller that builds action: TokenScope from external input — e.g. a wire u32 masked into a smaller subset — that happens to mask to NONE would receive a blanket true against any token. Short-circuit NONE so the caller’s “do they have permission X” question rejects the no-op action.

pub const fn intersect(self, other: TokenScope) -> TokenScope

Restrict this scope to only include permissions in other.

pub const fn union(self, other: TokenScope) -> TokenScope

Combine with another scope.

pub fn with_channel(self, channel_hash: u64) -> ScopedToken

Optional channel hash filter. If set, token only applies to channels matching this canonical ChannelHash.

Trait Implementations

impl Clone for TokenScope

fn clone(&self) -> TokenScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TokenScope

impl Debug for TokenScope

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

Formats the value using the given formatter.

impl Eq for TokenScope

impl PartialEq for TokenScope

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