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

use std::iter;

use bytes::Bytes;
use libipld::Cid;

//--------------------------------------------------------------------------------------------------
// Traits
//--------------------------------------------------------------------------------------------------

/// A trait for types that can hold [CID][cid] references to some data.
///
/// [cid]: https://docs.ipfs.tech/concepts/content-addressing/
pub trait IpldReferences {
    /// Returns all the direct CID references the type has to other data.
    fn get_references<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Cid> + Send + 'a>;
}

//--------------------------------------------------------------------------------------------------
// Macros
//--------------------------------------------------------------------------------------------------

macro_rules! impl_ipld_references {
    (($($name:ident),+)) => {
        impl<$($name),+> IpldReferences for ($($name,)+)
        where
            $($name: IpldReferences,)*
        {
            fn get_references<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Cid> + Send + 'a> {
                #[allow(non_snake_case)]
                let ($($name,)+) = self;
                Box::new(
                    Vec::new().into_iter()
                    $(.chain($name.get_references()))+
                )
            }
        }
    };
    ($type:ty) => {
        impl IpldReferences for $type {
            fn get_references<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Cid> + Send + 'a> {
                Box::new(std::iter::empty())
            }
        }
    }
}

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

// Nothing
impl_ipld_references!(());

// Scalars
impl_ipld_references!(bool);
impl_ipld_references!(u8);
impl_ipld_references!(u16);
impl_ipld_references!(u32);
impl_ipld_references!(u64);
impl_ipld_references!(u128);
impl_ipld_references!(usize);
impl_ipld_references!(i8);
impl_ipld_references!(i16);
impl_ipld_references!(i32);
impl_ipld_references!(i64);
impl_ipld_references!(i128);
impl_ipld_references!(isize);
impl_ipld_references!(f32);
impl_ipld_references!(f64);

// Containers
impl_ipld_references!(Vec<u8>);
impl_ipld_references!(&[u8]);
impl_ipld_references!(Bytes);
impl_ipld_references!(String);
impl_ipld_references!(&str);

// Tuples
impl_ipld_references!((A, B));
impl_ipld_references!((A, B, C));
impl_ipld_references!((A, B, C, D));
impl_ipld_references!((A, B, C, D, E));
impl_ipld_references!((A, B, C, D, E, F));
impl_ipld_references!((A, B, C, D, E, F, G));
impl_ipld_references!((A, B, C, D, E, F, G, H));

impl<T> IpldReferences for Option<T>
where
    T: IpldReferences,
{
    fn get_references<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Cid> + Send + 'a> {
        match self {
            Some(value) => Box::new(value.get_references()),
            None => Box::new(iter::empty()),
        }
    }
}