Enum Error 

pub enum Error {
    NotFound,
    InvalidArgument(String),
    WrongType {
        expected: &'static str,
        got: &'static str,
    },
    Encode(String),
    Decode(String),
}

Errors returned by heaplet operations.

Most APIs return Result<_, Error>. Common failure modes:

• Error::WrongType: the key exists but stores a different structure type
• Error::NotFound: an operation requires a key/element to exist
• Error::InvalidArgument: invalid input such as out-of-range indices
• Error::Encode / Error::Decode: codec failures when converting values

Example

use heaplet::{Error, Store};

let store = Store::new();

// Create a hash under "k".
store.hash("k").hset("f", &1_i64).unwrap();

// Now try to use "k" as a KV/String key => WrongType.
let err = store.kv().get::<i64>("k").unwrap_err();

match err {
    Error::WrongType { expected, got } => {
        assert_eq!(expected, "string");
        assert_eq!(got, "hash");
    }
    other => panic!("unexpected error: {other}"),
}

Variants

NotFound

The requested key or element was not found.

InvalidArgument(String)

The caller provided an invalid argument (e.g. out-of-range index).

WrongType

The operation was attempted on a key holding a different value type.

Fields

expected: &'static str

Expected value type.

got: &'static str

Actual value type stored under the key.

Encode(String)

Encoding failed.

Decode(String)

Decoding failed.

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, f: &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.