Enum maelstrom::Error

pub enum Error {
    Timeout,
    NotSupported(String),
    TemporarilyUnavailable,
    MalformedRequest,
    Crash,
    Abort,
    KeyDoesNotExist,
    KeyAlreadyExists,
    PreconditionFailed,
    TxnConflict,
    Custom(i32, String),
}

source.

Variants

Timeout

Indicates that the requested operation could not be completed within a timeout.

NotSupported(String)

Use this error to indicate that a requested operation is not supported by the current implementation. Helpful for stubbing out APIs during development.

TemporarilyUnavailable

Indicates that the operation definitely cannot be performed at this time–perhaps because the server is in a read-only state, has not yet been initialized, believes its peers to be down, and so on. Do not use this error for indeterminate cases, when the operation may actually have taken place.

MalformedRequest

The client’s request did not conform to the server’s expectations, and could not possibly have been processed.

Crash

Indicates that some kind of general, indefinite error occurred. Use this as a catch-all for errors you can’t otherwise categorize, or as a starting point for your error handler: it’s safe to return internal-error for every problem by default, then add special cases for more specific errors later.

Abort

Indicates that some kind of general, definite error occurred. Use this as a catch-all for errors you can’t otherwise categorize, when you specifically know that the requested operation has not taken place. For instance, you might encounter an indefinite failure during the prepare phase of a transaction: since you haven’t started the commit process yet, the transaction can’t have taken place. It’s therefore safe to return a definite abort to the client.

KeyDoesNotExist

The client requested an operation on a key which does not exist (assuming the operation should not automatically create missing keys).

KeyAlreadyExists

The client requested the creation of a key which already exists, and the server will not overwrite it.

PreconditionFailed

The requested operation expected some conditions to hold, and those conditions were not met. For instance, a compare-and-set operation might assert that the value of a key is currently 5; if the value is 3, the server would return precondition-failed.

TxnConflict

The requested transaction has been aborted because of a conflict with another transaction. Servers need not return this error on every conflict: they may choose to retry automatically instead.

Custom(i32, String)

Custom error code for anything you would like to add.

Implementations

impl Error

pub fn code(&self) -> i32

pub fn description(&self) -> &str

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

fn from(value: &MessageBody) -> Self

Converts to this type from the input type.

impl From<Error> for ErrorMessageBody

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<ErrorMessageBody> for Error

fn from(value: ErrorMessageBody) -> 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