Enum DecodeError 

pub enum DecodeError {
    BufferUnderflow,
    MissingField {
        ty: &'static str,
        field: &'static str,
    },
    DuplicateField {
        ty: &'static str,
        field: &'static str,
        tag: u8,
    },
    UnknownWireType {
        ty: &'static str,
        value: u8,
        tag: u8,
    },
    UnknownTag {
        ty: &'static str,
        tag: u8,
    },
    LengthDelimitedOverflow,
    Custom(Cow<'static, str>),
}

A message decoding error.

DecodeError indicates that the input buffer does not contain a valid message. The error details should be considered ‘best effort’: in general it is not possible to exactly pinpoint why data is malformed.

Variants

BufferUnderflow

Returned when the buffer does not have enough data to decode the message.

MissingField

Returned when the buffer does not contain the required field.

Fields

ty: &'static str

The type of the message.

field: &'static str

The name of the field.

DuplicateField

Returned when the buffer contains duplicate fields for the same tag in a message.

Fields

ty: &'static str

The type of the message.

field: &'static str

The name of the field.

tag: u8

The tag of the field.

UnknownWireType

Returned when there is a unknown wire type.

Fields

ty: &'static str

The type of the message.

value: u8

The unknown wire type value.

tag: u8

The tag of the field.

UnknownTag

Returned when finding a unknown tag.

Fields

ty: &'static str

The type of the message.

tag: u8

The unknown tag value.

LengthDelimitedOverflow

Returned when fail to decode the length-delimited

Custom(Cow<'static, str>)

A custom decoding error.

Implementations

impl DecodeError

pub const fn is_buffer_underflow(&self) -> bool

Returns true if this value is of type BufferUnderflow. Returns false otherwise

pub const fn is_missing_field(&self) -> bool

Returns true if this value is of type MissingField. Returns false otherwise

pub const fn is_duplicate_field(&self) -> bool

Returns true if this value is of type DuplicateField. Returns false otherwise

pub const fn is_unknown_wire_type(&self) -> bool

Returns true if this value is of type UnknownWireType. Returns false otherwise

pub const fn is_unknown_tag(&self) -> bool

Returns true if this value is of type UnknownTag. Returns false otherwise

pub const fn is_length_delimited_overflow(&self) -> bool

Returns true if this value is of type LengthDelimitedOverflow. Returns false otherwise

pub const fn is_custom(&self) -> bool

Returns true if this value is of type Custom. Returns false otherwise

impl DecodeError

pub const fn buffer_underflow() -> Self

Creates a new buffer underflow decoding error.

pub const fn missing_field(ty: &'static str, field: &'static str) -> Self

Creates a new missing field decoding error.

pub const fn duplicate_field( ty: &'static str, field: &'static str, tag: u8, ) -> Self

Creates a new duplicate field decoding error.

pub const fn unknown_wire_type(ty: &'static str, value: u8, tag: u8) -> Self

Creates a new unknown wire type decoding error.

pub const fn unknown_tag(ty: &'static str, tag: u8) -> Self

Creates a new unknown tag decoding error.

pub fn custom<T>(value: T) -> Self

where T: Into<Cow<'static, str>>,

Creates a custom decoding error.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

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<ConstDecodeError> for DecodeError

fn from(e: ConstDecodeError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for DecodeError

fn from(e: DecodeError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for ProtoDecoderError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl PartialEq for DecodeError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DecodeError

impl StructuralPartialEq for DecodeError