Enum SessionError 

#[non_exhaustive]
pub enum SessionError {
    Cancel,
    Internal,
    Unauthorized,
    ProtocolViolation,
    KeyValueFormatting,
    GoawayTimeout,
    Timeout,
    Version,
    App(u16),
    Unknown(u32),
}

A code sent when terminating the session.

One of the two wire registries specified by moq-lite, which reuse moq-transport’s codes unchanged; 64+ are the application’s. The stream registry is StreamError and the two are disjoint, so the same integer means different things in each.

Every variant is a registered code, so the registry round-trips: 32 through 47 is reserved, nothing is sent there, and a received one stays Unknown.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cancel

Ending the session normally, with no error.

Internal

Something went wrong that isn’t worth a dedicated code.

Unauthorized

The peer’s token does not grant the requested path or operation. Retrying with the same credentials will fail again.

ProtocolViolation

The peer broke a protocol rule; the session is unusable.

KeyValueFormatting

A key-value pair was malformed or repeated more than allowed.

GoawayTimeout

The peer did not close within the GOAWAY drain deadline.

Timeout

A control message took too long.

Version

No version could be negotiated.

App(u16)

An application-chosen code, offset into the 64+ range on the wire.

Unknown(u32)

A code this version does not recognize, kept verbatim.

Implementations

impl SessionError

pub fn to_code(&self) -> u32

The integer sent on the wire.

pub fn from_code(code: u32) -> Self

Decode a code received off the wire.

Unlike a raw peer code, the registered ones are specified, so decoding them is a wire contract rather than an assumption. Anything unregistered stays Self::Unknown, including the reserved 32-47.

Trait Implementations

impl Clone for SessionError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionError

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

Formats the value using the given formatter.

impl Display for SessionError

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

Formats the value using the given formatter.

impl Eq for SessionError

impl Error for SessionError

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.

impl From<&Error> for SessionError

Which session code to send for a local error.

Lossy on purpose: Error describes what went wrong locally, while the registry is what the peer can act on. Anything stream-scoped reaching a session close is a bug on our side, so it degrades to SessionError::Internal rather than inventing a code.

fn from(err: &Error) -> Self

Converts to this type from the input type.

impl From<SessionError> for StreamError

fn from(source: SessionError) -> Self

Converts to this type from the input type.

impl From<SessionError> for Error

Preserve the session registry when carrying a protocol error.

fn from(err: SessionError) -> Self

Converts to this type from the input type.

impl PartialEq for SessionError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SessionError