basteh 0.4.0-alpha.5

Generic kv storage with replaceable backend
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

use std::{convert::Infallible, error::Error};

use thiserror::Error;

/// Error type that will be returned from all fallible methods of basteh.
///
/// implementers should generally use Custom variant for their own errors.
#[derive(Debug, Error)]
pub enum BastehError {
    /// States that the method(mostly expiration methods) is not supported by the backend
    #[error("BastehError: Method not supported for the Basteh backend provided")]
    MethodNotSupported,
    /// States that the retrieved number is invalid
    #[error("BastehError: Value is not a valid number or mutation will result in overflow")]
    InvalidNumber,
    /// States that the retrieved number is invalid
    #[error("BastehError: Invalid type requested from backend")]
    TypeConversion,
    /// An error from the underlying backend
    #[error("BastehError: {:?}", self)]
    Custom(Box<dyn Error + Send>),
}

impl BastehError {
    /// Shortcut method to construct Custom variant
    pub fn custom<E>(err: E) -> Self
    where
        E: 'static + Error + Send,
    {
        Self::Custom(Box::new(err))
    }
}

impl From<Infallible> for BastehError {
    fn from(_value: Infallible) -> Self {
        // It never happens
        BastehError::MethodNotSupported
    }
}

pub type Result<T> = std::result::Result<T, BastehError>;