Struct EncodeError 

#[non_exhaustive]
pub struct EncodeError {
    pub context: &'static str,
    pub label: &'static str,
    pub values: [u32; 2],
    pub decode_offset: Option<u32>,
}

A value an encoder or validator refused to put on the wire, without an allocated message (#1802).

It displays as encoding error: {context}: {label}, leaving out {context}: when the context is empty and with the label’s placeholders filled from values. One that restates a decoder’s refusal of octets the encoder was handed, such as a captured raw value (see from_decode), adds that refusal’s offset: encoding error: decoding error at offset {offset}: {context}: {label}.

use bacnet_types::error::{EncodeError, Error};

let refused = EncodeError::new("mac-address of {} octets exceeds the {}-octet limit")
    .within("BACnetAddress")
    .with_values(19, 18);
assert_eq!(
    Error::from(refused).to_string(),
    "encoding error: BACnetAddress: mac-address of 19 octets exceeds the 18-octet limit"
);

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.

context: &'static str

The production or member being encoded, such as "BACnetNameValue"; empty when the encoder names none.

label: &'static str

What is wrong, such as "exceeds {} property values".

values: [u32; 2]

The numbers the label’s placeholders stand for, in order; a slot with no placeholder is 0. They are 32 bits wide, so the error fits in Error without widening it: a number restated from a decoder’s refusal past u32::MAX reads as u32::MAX.

decode_offset: Option<u32>

The offset, within the octets the encoder was handed, of the fault a decoder found there; None when the refusal is the encoder’s own. An offset past u32::MAX reads as u32::MAX.

Implementations

impl EncodeError

pub const fn new(label: &'static str) -> Self

A refusal described by label.

pub fn from_decode(refused: &DecodeError) -> Self

The refusal of octets an encoder was handed, which refused found malformed: its context, label, numbers and offset. A list item index the decoder named is not kept.

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

The same refusal, met encoding context.

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

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

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

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

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

The text without the encoding error: prefix.

Trait Implementations

impl Clone for EncodeError

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 EncodeError

impl Debug for EncodeError

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

Formats the value using the given formatter.

impl Display for EncodeError

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

Formats the value using the given formatter.

impl Eq for EncodeError

impl Error for EncodeError

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

fn from(error: EncodeError) -> Self

Converts to this type from the input type.

impl Hash for EncodeError

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 EncodeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodeError