Struct DecodeError 

#[non_exhaustive]
pub struct DecodeError {
    pub offset: usize,
    pub kind: DecodingKind,
    pub context: &'static str,
    pub label: &'static str,
    pub values: [u64; 2],
    pub index: Option<u16>,
}

A decoder’s refusal, without an allocated message (#1646).

It displays as decoding error at offset {offset}: {context}: {label}, leaving out {context}: when the context is empty, and with each {} in the label replaced by the next of values in decimal, each {:#x} in hexadecimal, or each {:#04X} as an upper-case, zero-padded octet such as 0x0B. An index follows the context as [{index}].

use bacnet_types::error::{DecodeError, DecodingKind, Error};

let refused = DecodeError::new(DecodingKind::Trailing, 9, "{} trailing byte(s)")
    .within("IAm")
    .with_value(2);
assert_eq!(refused.to_string(), "decoding error at offset 9: IAm: 2 trailing byte(s)");
assert_eq!(Error::from(refused).reject_reason(), Some(DecodingKind::Trailing.reject_reason()));

It is #[non_exhaustive]: build one with new and the builder methods.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

offset: usize

Byte offset where the decoder found the fault.

kind: DecodingKind

Which kind of fault it is.

context: &'static str

The production or member being decoded, such as "WhoIs low limit"; empty when the decoder names none.

label: &'static str

What is wrong, such as "expected context tag [{}]".

values: [u64; 2]

The numbers the label’s placeholders stand for, in order; a slot with no placeholder is 0.

index: Option<u16>

The zero-based position of the list item the fault is in, such as a file record, when the decoder names one (#1776). It sits in the struct’s padding, so the error is no larger for it.

Implementations

impl DecodeError

pub const fn new(kind: DecodingKind, offset: usize, label: &'static str) -> Self

A fault of kind at offset, described by label.

pub const fn within(self, context: &'static str) -> Self

The same fault, met decoding context.

pub const fn at_item(self, index: u16) -> Self

The same fault, in the list item at index.

pub const fn with_value(self, value: u64) -> Self

The same fault, with the number the label’s one placeholder stands for.

pub const fn with_values(self, first: u64, second: u64) -> Self

The same fault, with the numbers the label’s two placeholders stand for.

pub fn message(&self) -> impl Display + '_

The context and label with their numbers, without the decoding error at offset {offset}: prefix.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeError

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for DecodeError

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

fn from(error: DecodeError) -> Self

Converts to this type from the input type.

impl Hash for DecodeError

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecodeError