Struct Error

pub struct Error {
    pub error_code: ErrorCode,
    pub data: BytesMut,
    /* private fields */
}

ERROR Frame (0x0B)

Error frames are used for errors on individual requests/streams as well as connection errors and in response to SETUP frames.

Frame Contents

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           Stream ID                           |
+-----------+-+-+---------------+-------------------------------+
|Frame Type |0|0|      Flags    |
+-----------+-+-+---------------+-------------------------------+
|                          Error Code                           |
+---------------------------------------------------------------+
                           Error Data

Note

Unsed values in the range of 0x0001 to 0x00300 are reserved for future protocol use. Values in the range of 0x00301 to 0xFFFFFFFE are reserved for application layer errors.

Fields

error_code: ErrorCode

Type of Error.

See ErrorCode of valid Error Codes.

data: BytesMut

Error Data

Includes Payload describing error information. Error Data SHOULD b a UTF-8 encoded string. The string MUST NOT be null terminated.

Implementations

impl Error

pub const fn builder() -> ErrorBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Decoder for Error

type Error = Error

The type of error that can occur if decoding fails.

fn decode(__buf: &mut BytesMut) -> Result<Self, Self::Error>

Decodes a value from the given buffer.

fn has_enough_bytes(_buf: &BytesMut) -> bool

Returns true if the given buffer can be decoded.

impl Encoder for Error

type Error = Error

The type of error that can occur if encoding fails.

fn encode(input: &Self, __buf: &mut BytesMut) -> Result<(), Self::Error>

Encodes the given input into the output buffer.

fn size_of(input: &Self) -> usize

Returns the number of bytes required to encode the given input.

impl FrameVariant for Error

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

const REQUIRED_FLAGS: FrameFlags = _

Flags that must be set for a variant.

impl From<Error> for Frame

fn from(value: Error) -> Self

Converts to this type from the input type.