Enum drmem_api::Error

pub enum Error {
    NotFound,
    InUse,
    DeviceDefined(String),
    MissingPeer(String),
    TypeError,
    InvArgument(String),
    DbCommunicationError,
    ProtocolError(String),
    AuthenticationError,
    TimeoutError,
    OperationError,
    BadConfig(String),
    ParseError(String),
    UnknownError,
}

Enumerates all the errors that can be reported in DrMem. Authors for new drivers or storage backends should try to map their errors into one of these values. If no current value is appropriate, a new one could be added (requiring a new release of this crate) but make sure the new error code is generic enough that it may be useful for other drivers or backends. For instance, don’t add an error value that is specific to Redis. Add a more general value and use the associated description string to explain the details.

Variants

NotFound

Returned whenever a resource cannot be found.

InUse

A resource is already in use.

DeviceDefined(String)

The device name is already registered to another driver.

MissingPeer(String)

Reported when the peer of a communication channel has closed its handle.

TypeError

A type mismatch is preventing the operation from continuing.

InvArgument(String)

An invalid value was provided.

DbCommunicationError

Returned when a communication error occurred with the backend database. Each backend will have its own recommendations on how to recover.

ProtocolError(String)

Communication was disrupted due to one end not following a protocol.

AuthenticationError

The requested operation cannot complete because the process hasn’t provided proper authentication credentials.

TimeoutError

An operation didn’t complete in a timely fashion.

OperationError

The requested operation couldn’t complete. The description field will have more information for the user.

BadConfig(String)

A bad parameter was given in a configuration or a configuration was missing a required parameter.

ParseError(String)

There was a problem parsing a string. The associated string will describe how the parsing failed.

UnknownError

A dependent library introduced a new error that hasn’t been properly mapped in DrMem. This needs to be reported as a bug.

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, f: &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, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl From<RecvError> for Error

fn from(_error: RecvError) -> Self

Converts to this type from the input type.

impl<T> From<SendError<T>> for Error

fn from(_error: SendError<T>) -> Self

Converts to this type from the input type.

impl PartialEq<Error> 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 Eq for Error

impl StructuralEq for Error

impl StructuralPartialEq for Error