Struct ErrorHeader 

pub struct ErrorHeader {
    pub code: u64,
    pub message: Option<String>,
}

ERROR header.

Legal only on the reply half of a bidirectional stream: an ERROR is the alternative to a reply, so it needs no reference to what it answers.

Fields

code: u64

Raw error code.

message: Option<String>

Human-readable detail; never machine-interpreted.

Implementations

impl ErrorHeader

pub fn new(code: ErrorCode) -> ErrorHeader

Builds a header for a known error code.

pub fn error_code(&self) -> Option<ErrorCode>

The error code, or None for an unknown one.

pub fn encode(&self) -> Vec<u8>

Encodes the header.

pub fn encode_into(&self, out: &mut Vec<u8>)

Appends the encoded header to out, for a send path that reuses a buffer (B-250). The canonical form has one implementation and this is it; Self::encode is a wrapper.

pub fn decode(bytes: &[u8]) -> Result<ErrorHeader, HeaderError>

Decodes the header.

Trait Implementations

impl Clone for ErrorHeader

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 ErrorHeader

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

Formats the value using the given formatter.

impl Eq for ErrorHeader

impl PartialEq for ErrorHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorHeader