Enum BvllError 

#[non_exhaustive]
pub enum BvllError {
    TooShort {
        length: usize,
    },
    NotBip {
        bvlc_type: u8,
    },
    LengthMismatch {
        declared: usize,
        received: usize,
    },
    UnknownFunction {
        function: u8,
    },
    PayloadLength {
        function: BvlcFunction,
        length: usize,
    },
    TableLength {
        length: usize,
        entry_length: usize,
    },
    AddressLength {
        length: usize,
    },
    TooLong {
        length: usize,
    },
    UndefinedResultCode {
        code: u16,
    },
    BufferExhausted {
        needed: usize,
        available: usize,
    },
}

A BVLL message could not be decoded or encoded.

Each variant names the direction it comes from. None of them allocates, so the type is Copy. Later releases may add variants, so a match outside this crate needs a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TooShort

Decode: the datagram is shorter than the 4-octet BVLL header.

Fields

length: usize

Octets in the datagram.

NotBip

Decode: the BVLC Type octet is not 0x81, so the datagram is not a B/IP BVLL message (Annex J.2).

Fields

bvlc_type: u8

The type octet received.

LengthMismatch

Decode: the Length field disagrees with the datagram. It counts the whole message, header included (Annex J.2), so a datagram cut short and one with octets after the message both fail here.

Fields

declared: usize

Length the header declares.

received: usize

Octets in the datagram.

UnknownFunction

Decode: a function code Annex J.2 doesn’t define, so its payload has no known layout.

Fields

function: u8

The function octet.

PayloadLength

Decode: the payload doesn’t fit its function’s layout (see BvlcFunction::payload_shape).

Fields

function: BvlcFunction

The message’s function.

length: usize

Octets after the header.

TableLength

A table’s octets are not a whole number of entries.

Fields

length: usize

Octets supplied.

entry_length: usize

Octets per entry.

AddressLength

A B/IP address that is not 6 octets long (Annex J.1.2).

Fields

length: usize

Octets supplied.

TooLong

Encode: the message is longer than its 16-bit Length field can state.

Fields

length: usize

Octets the message would take.

UndefinedResultCode

Encode: a BVLC-Result whose code Annex J.2.1.1 doesn’t define.

Fields

code: u16

The code supplied.

BufferExhausted

Encode: the sink has no room for the message. Nothing was written to a sink with a fixed capacity.

Fields

needed: usize

Octets the write needed.

available: usize

Room the sink had.

Trait Implementations

impl Clone for BvllError

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 BvllError

impl Debug for BvllError

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

Formats the value using the given formatter.

impl Display for BvllError

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

Formats the value using the given formatter.

impl Eq for BvllError

impl Error for BvllError

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<SinkFull> for BvllError

fn from(full: SinkFull) -> Self

Converts to this type from the input type.

impl PartialEq for BvllError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BvllError