monoutils-store 0.2.1

`monoutils-store` is a library for working with IPLD content-addressed stores (CAS).
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use std::{
    error::Error,
    fmt::{self, Display},
};

use libipld::Cid;
use thiserror::Error;

use super::Codec;

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// The result of a file system operation.
pub type StoreResult<T> = Result<T, StoreError>;

/// An error that occurred during a file system operation.
#[derive(Debug, Error, PartialEq)]
pub enum StoreError {
    /// The block was not found.
    #[error("Block not found: {0}")]
    BlockNotFound(Cid),

    /// The node block is too large.
    #[error("Node block too large: {0} > {1}")]
    NodeBlockTooLarge(u64, u64),

    /// The raw block is too large.
    #[error("Raw block too large: {0} > {1}")]
    RawBlockTooLarge(u64, u64),

    /// Codec not supported.
    #[error("Unsupported Codec: {0}")]
    UnsupportedCodec(u64),

    /// Expected block codec does not match the actual codec.
    #[error("Unexpected block codec: expected: {0:?} got: {1:?}")]
    UnexpectedBlockCodec(Codec, Codec),

    /// Custom error.
    #[error("Custom error: {0}")]
    Custom(#[from] AnyError),

    /// Layout error.
    #[error("Layout error: {0}")]
    LayoutError(#[from] LayoutError),
}

/// An error that occurred during a layout operation.
#[derive(Debug, Error, PartialEq)]
pub enum LayoutError {
    /// No leaf block found.
    #[error("No leaf block found")]
    NoLeafBlock,
}

/// An error that can represent any error.
#[derive(Debug)]
pub struct AnyError {
    error: anyhow::Error,
}

//--------------------------------------------------------------------------------------------------
// Methods
//--------------------------------------------------------------------------------------------------

impl StoreError {
    /// Creates a new `Err` result.
    pub fn custom(error: impl Into<anyhow::Error>) -> StoreError {
        StoreError::Custom(AnyError {
            error: error.into(),
        })
    }
}

impl AnyError {
    /// Downcasts the error to a `T`.
    pub fn downcast<T>(&self) -> Option<&T>
    where
        T: Display + fmt::Debug + Send + Sync + 'static,
    {
        self.error.downcast_ref::<T>()
    }
}

//--------------------------------------------------------------------------------------------------
// Functions
//--------------------------------------------------------------------------------------------------

/// Creates an `Ok` `FsResult` d.
#[allow(non_snake_case)]
pub fn Ok<T>(value: T) -> StoreResult<T> {
    Result::Ok(value)
}

//--------------------------------------------------------------------------------------------------
// Trait Implementations
//--------------------------------------------------------------------------------------------------

impl PartialEq for AnyError {
    fn eq(&self, other: &Self) -> bool {
        self.error.to_string() == other.error.to_string()
    }
}

impl Display for AnyError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.error)
    }
}

impl Error for AnyError {}