anystore 0.2.1

Polymorphic, type-safe, composable async API for arbitrary stores
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

use super::*;

pub trait AddressableList<
    'a,
    ListAddr: Address + SubAddress<Self::AddedAddress, Output = Self::ItemAddress>,
>: Addressable<ListAddr> + Addressable<Self::ItemAddress>
{
    /// The "added" part of the address (filename in the dir, key of the map, etc.)
    type AddedAddress: Clone + 'static;
    /// The address of the item in the list.
    type ItemAddress: Address;

    /// Uses pinned stream as a reasonable default because most of the
    /// time you probably don't care too much.
    /// You can use `.boxed_local()` on any stream with the correct items
    /// to create this type.
    type ListOfAddressesStream: 'a
        + Stream<Item = StoreResult<(Self::AddedAddress, Self::ItemAddress), Self>> = Pin<
        Box<dyn 'a + Stream<Item = StoreResult<(Self::AddedAddress, Self::ItemAddress), Self>>>,
    >;

    fn list(&self, addr: &ListAddr) -> Self::ListOfAddressesStream;
}

pub trait AddressableInsert<
    'a,
    Value,
    ListAddr: Address + SubAddress<Self::AddedAddress, Output = Self::ItemAddress>,
>: AddressableList<'a, ListAddr>
{
    /// Inserts a list, returning the addresses of the items.
    fn insert(&self, addr: &ListAddr, items: Vec<Value>) -> Self::ListOfAddressesStream;
}

pub trait AddressableQuery<
    'a,
    Query,
    ListAddr: Address + SubAddress<Self::AddedAddress, Output = Self::ItemAddress>,
>: AddressableList<'a, ListAddr>
{
    /// Queries a list. Every store can define its own queries.
    ///
    /// Typically this trait should be implemented only if this is somehow
    /// optimized. If this is going to perform a full listing with a client-side filter,
    /// it's better not to implement this trait, but use wrappers.
    fn query(&self, addr: &ListAddr, query: Query) -> Self::ListOfAddressesStream;
}