Enum Error

#[non_exhaustive]
pub enum Error {
    UnexpectedSyncResponse,
    InvalidBoolean,
    InvalidHeader,
    IncompatibleMagicNumber(u8),
    UnsupportedWireFormatVersion,
    Invalid,
    OutOfRange,
    ExtraBytes,
    ExtraHandles,
    NonZeroPadding {
        padding_start: usize,
    },
    MaxRecursionDepth,
    NotNullable,
    UnexpectedNullRef,
    Utf8Error,
    VectorTooLong {
        max_length: usize,
        actual_length: usize,
    },
    StringTooLong {
        max_bytes: usize,
        actual_bytes: usize,
    },
    UnknownOrdinal {
        ordinal: u64,
        protocol_name: &'static str,
    },
    UnsupportedMethod {
        method_name: &'static str,
        protocol_name: &'static str,
    },
    InvalidBitsValue,
    InvalidEnumValue,
    UnknownUnionTag,
    PollAfterCompletion,
    InvalidRequestTxid,
    InvalidResponseTxid,
    InvalidResponseOrdinal,
    InvalidPresenceIndicator,
    InvalidInlineBitInEnvelope,
    InvalidInlineMarkerInEnvelope,
    InvalidNumBytesInEnvelope,
    InvalidNumHandlesInEnvelope,
    InvalidHostHandle,
    IncorrectHandleSubtype {
        expected: ObjectType,
        received: ObjectType,
    },
    MissingExpectedHandleRights {
        missing_rights: Rights,
    },
    HandleReplace(Status),
    ServerResponseWrite(TransportError),
    ServerRequestRead(TransportError),
    ServerEpitaphWrite(TransportError),
    ClientRead(TransportError),
    ClientWrite(TransportError),
    ClientCall(Status),
    ClientEvent(Status),
    ClientChannelClosed {
        status: Status,
        protocol_name: &'static str,
    },
    AsyncChannel(Status),
}

The error type used by FIDL operations.

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.

UnexpectedSyncResponse

InvalidBoolean

InvalidHeader

IncompatibleMagicNumber(u8)

UnsupportedWireFormatVersion

Invalid

OutOfRange

ExtraBytes

ExtraHandles

NonZeroPadding

Fields

padding_start: usize

Index of the first byte of the padding, relative to the beginning of the message.

MaxRecursionDepth

NotNullable

UnexpectedNullRef

Utf8Error

VectorTooLong

Fields

max_length: usize

Maximum length, i.e. the N in vector<T>:N.

actual_length: usize

Actual length of the vector (number of elements).

StringTooLong

Fields

max_bytes: usize

Maximum length in bytes, i.e. the N in string:N.

actual_bytes: usize

Actual length of the string in bytes.

UnknownOrdinal

Fields

ordinal: u64

protocol_name: &'static str

UnsupportedMethod

Fields

method_name: &'static str

protocol_name: &'static str

InvalidBitsValue

InvalidEnumValue

UnknownUnionTag

PollAfterCompletion

InvalidRequestTxid

InvalidResponseTxid

InvalidResponseOrdinal

InvalidPresenceIndicator

InvalidInlineBitInEnvelope

InvalidInlineMarkerInEnvelope

InvalidNumBytesInEnvelope

InvalidNumHandlesInEnvelope

InvalidHostHandle

IncorrectHandleSubtype

Fields

expected: ObjectType

received: ObjectType

MissingExpectedHandleRights

Fields

missing_rights: Rights

HandleReplace(Status)

ServerResponseWrite(TransportError)

ServerRequestRead(TransportError)

ServerEpitaphWrite(TransportError)

ClientRead(TransportError)

ClientWrite(TransportError)

ClientCall(Status)

ClientEvent(Status)

ClientChannelClosed

Fields

status: Status

The epitaph or Status::PEER_CLOSED.

protocol_name: &'static str

The name of the protocol at the other end of the channel.

AsyncChannel(Status)

Implementations

impl Error

pub fn is_closed(&self) -> bool

Returns true if the error was sourced by a closed channel.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.