Enum soketto::base::Error

#[non_exhaustive]
pub enum Error {
    Io(Error),
    UnknownOpCode,
    ReservedOpCode,
    FragmentedControl,
    InvalidControlFrameLen,
    InvalidReservedBit(u8),
    PayloadTooLarge {
        actual: u64,
        maximum: u64,
    },
}

Error cases the base frame decoder may encounter.

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.

Io(Error)

An I/O error has been encountered.

UnknownOpCode

Some unknown opcode number has been decoded.

ReservedOpCode

The opcode decoded is reserved.

FragmentedControl

A fragmented control frame (fin bit not set) has been decoded.

InvalidControlFrameLen

A control frame with an invalid length code has been decoded.

InvalidReservedBit(u8)

The reserved bit is invalid.

PayloadTooLarge

The payload length of a frame exceeded the configured maximum.

Fields of PayloadTooLarge

actual: u64maximum: u64

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<UnknownOpCode> for Error

fn from(_: UnknownOpCode) -> Self

Performs the conversion.