Enum ChannelAccessError 

pub enum ChannelAccessError {
    NotRegistered {
        name: String,
    },
    Quiesced {
        name: String,
        reason: String,
    },
    RosterUnavailable {
        message: String,
    },
    ConsoleNamespace {
        name: String,
    },
    ConsoleTapTarget {
        name: String,
    },
    ConsoleTapLimit {
        name: String,
        limit: usize,
    },
}

The hot-path admission refusal.

Produced by the roster admission funnel and rendered to the wire with a reason code. Distinct from ChannelRegistryError because this one crosses to a client: every variant here has to answer Self::reason_code.

Variants

NotRegistered

No entry of this name is on the roster.

Fields

name: String

The refused channel name.

Quiesced

The entry is on the roster but quiesced.

Fields

name: String

The refused channel name.

reason: String

The cause recorded at the transition, carried to the caller.

RosterUnavailable

The roster lock is poisoned, so no admission decision can be made.

Fields

message: String

The diagnostic for the unavailable roster.

ConsoleNamespace

A connection asked to publish under console.. Only the server writes there, so a console reading those subjects is never shown a client’s record as the server’s. Subscribing stays open: the console is itself a connection that reads them.

Fields

name: String

The refused channel name.

ConsoleTapTarget

A subscribe to console.tap.<target> named no target, or a target under console.: the tap never taps the console’s own records.

Fields

name: String

The refused channel name.

ConsoleTapLimit

A subscribe would start one more live tap than the server’s bound.

Fields

name: String

The refused channel name.

limit: usize

The bound on live taps.

Implementations

impl ChannelAccessError

pub const fn reason_code(&self) -> u16

The stable wire reason code for this refusal.

The two roster codes are minted in liminal-protocol so an SDK client — which depends on that crate and not on this one — names them instead of hardcoding a literal. Self::RosterUnavailable keeps the undifferentiated server code: it is an internal fault, not a statement about the channel, and claiming otherwise would be a typed lie.

Trait Implementations

impl Debug for ChannelAccessError

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

Formats the value using the given formatter.

impl Display for ChannelAccessError

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

Formats the value using the given formatter.

impl Error for ChannelAccessError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.