Struct Error 

pub struct Error {
    pub code: u64,
    pub msg: String,
}

Error is sent along a response to a failed request.

Codes 0x00 through 0xff (inclusive) are reserved for protocol-wide errors. Codes 0x100 and above are defined by the request type and may be reused with different meanings for different requests. The message text is human, readable error, not a stable code.

Fields

code: u64

Error code for programmatic interpretation

msg: String

Error message for user interfacing

Implementations

impl Error

pub fn new(code: u64, msg: impl Into<String>) -> Self

Builds an error with a numeric code and a human-readable message. Codes from 0x100 are request-specific. Use Self::reserved for named protocol errors.

pub fn reserved(code: ReservedErrors, msg: impl Into<String>) -> Self

Builds an error from a reserved protocol code and a human-readable message.

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 Default for Error

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Error

impl<E: CodedError> From<E> for Error

fn from(error: E) -> Self

Converts an application error into its wire form, the code as assigned and the message as displayed.

impl From<Error> for Error

fn from(error: Error) -> Self

Wraps the peer’s error code and message in Error::Remote.

impl Hash for Error

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for Error

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error