Enum UWireError

#[non_exhaustive]
pub enum UWireError {
    BufferTooSmall {
        expected: usize,
        actual: usize,
    },
    InvalidPayload(String),
    MissingEncoding,
    MissingPayload,
    UnsupportedEncoding {
        expected: Box<PayloadEncoding>,
        actual: Box<PayloadEncoding>,
    },
    SerializationError(String),
}

Error type used by serialization-neutral payload helpers.

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.

BufferTooSmall

A caller-provided output buffer is too small for the serialized payload.

Fields

expected: usize

Required output size in bytes.

actual: usize

Provided output size in bytes.

InvalidPayload(String)

Payload bytes are malformed for the selected decoder.

MissingEncoding

A typed decode was requested, but the frame has no payload encoding.

MissingPayload

A typed decode was requested, but the frame has no payload bytes.

UnsupportedEncoding

The frame’s encoding is not compatible with the selected payload codec.

Fields

expected: Box<PayloadEncoding>

Encoding declared by the requested codec.

actual: Box<PayloadEncoding>

Encoding carried by the frame being decoded.

SerializationError(String)

Serializer or deserializer implementation failed.

Implementations

impl UWireError

pub fn buffer_too_small(expected: usize, actual: usize) -> Self

Creates a UWireError::BufferTooSmall value.

pub fn invalid_payload(message: impl Into<String>) -> Self

Creates a UWireError::InvalidPayload value.

pub fn invalid_payload_length(expected: usize, actual: usize) -> Self

Creates a stable payload length error.

pub fn serialization_error(message: impl Into<String>) -> Self

Creates a UWireError::SerializationError value.

Trait Implementations

impl Clone for UWireError

fn clone(&self) -> UWireError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UWireError

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

Formats the value using the given formatter.

impl Display for UWireError

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

Formats the value using the given formatter.

impl Error for UWireError

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<UWireError> for UStatus

fn from(value: UWireError) -> Self

Converts to this type from the input type.

impl PartialEq for UWireError

fn eq(&self, other: &UWireError) -> 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 UWireError

impl StructuralPartialEq for UWireError