Enum onc_rpc::Error

#[non_exhaustive]
pub enum Error {
    IncompleteMessage {
        buffer_len: usize,
        expected: usize,
    },
    IncompleteHeader,
    Fragmented,
    InvalidMessageType(u32),
    InvalidReplyType(u32),
    InvalidReplyStatus(u32),
    InvalidAuthData,
    InvalidAuthError(u32),
    InvalidRejectedReplyType(u32),
    InvalidLength,
    InvalidRpcVersion(u32),
    InvalidMachineName(Utf8Error),
    IOError(ErrorKind, String),
}

Error types returned by this crate.

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.

IncompleteMessage

The message header indicates the RPC message is longer than the amount of data in the buffer, or the buffer contains more than one message.

This error may also be returned if the RPC message parsed from the buffer is unexpectedly shorter than the header length indicates - in this case, buffer_len will be more than expected and may indicate a parsing error.

Fields

buffer_len: usize

The length of the buffer provided.

expected: usize

The length expected for this message type.

IncompleteHeader

The buffer is too small to contain the RPC header.

Fragmented

The RPC message is fragmented and needs to be reassembled.

This library doesn’t currently support fragmented messages and this error will be returned when parsing any message with the “last fragment” bit unset in the header.

InvalidMessageType(u32)

The message type in the RPC request is neither MessageType::Call or MessageType::Reply.

This is a violation of the spec.

InvalidReplyType(u32)

The message type in the RPC request is neither ReplyBody::Accepted or ReplyBody::Denied.

This is a violation of the spec.

InvalidReplyStatus(u32)

The reply status code is not one of the specified status codes.

This is a violation of the spec.

InvalidAuthData

The auth or verifier is invalid or malformed.

InvalidAuthError(u32)

The auth error code is not one of the specified error codes.

This is a violation of the spec.

InvalidRejectedReplyType(u32)

The rejected reply status code is not one of the specified status codes.

This is a violation of the spec.

InvalidLength

A variable length type has a malformed length value which would exceed the length of the buffer.

InvalidRpcVersion(u32)

The message contains a rpc protocol identifier that is not 2.

InvalidMachineName(Utf8Error)

The machine name contains non-UTF8 characters.

IOError(ErrorKind, String)

An I/O error occurred when trying to parse the buffer.

Trait Implementations

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)>

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

fn from(v: Error) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error