willow25 0.5.0-alpha.1

A ready-to-use implementation of the Willow specifications.
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

use willow_data_model::prelude as wdm;

use crate::prelude::{MCC, MCL, MPL, Path, SubspaceId};

/// A keylike value is one that can be used to uniquely identify an [Entry](https://willowprotocol.org/specs/data-model/index.html#Entry) within a [namespace](https://willowprotocol.org/specs/data-model/index.html#namespace)-specific [store](https://willowprotocol.org/specs/data-model/index.html#store).
///
/// A [subspace_id](https://willowprotocol.org/specs/data-model/index.html#entry_subspace_id) and a [path](https://willowprotocol.org/specs/data-model/index.html#entry_path) together uniquely identify an entry in a namespace, because between any two non-equal entries with of equal [subspace_id](https://willowprotocol.org/specs/data-model/index.html#entry_subspace_id), [path](https://willowprotocol.org/specs/data-model/index.html#entry_path), and [namespace_id](https://willowprotocol.org/specs/data-model/index.html#entry_namespace_id), one would overwrite the other.
pub trait Keylike: wdm::Keylike<MCL, MCC, MPL, SubspaceId> {
    /// Returns the [subspace_id](https://willowprotocol.org/specs/data-model/index.html#entry_subspace_id) of `self`.
    fn subspace_id(&self) -> &SubspaceId;

    /// Returns the [path](https://willowprotocol.org/specs/data-model/index.html#entry_path) of `self`.
    fn path(&self) -> &Path;
}

impl<T> Keylike for T
where
    T: wdm::Keylike<MCL, MCC, MPL, SubspaceId> + ?Sized,
{
    fn subspace_id(&self) -> &SubspaceId {
        self.wdm_subspace_id()
    }

    fn path(&self) -> &Path {
        self.wdm_path().into()
    }
}

impl wdm::Keylike<MCL, MCC, MPL, SubspaceId> for (SubspaceId, Path) {
    fn wdm_subspace_id(&self) -> &SubspaceId {
        &self.0
    }

    fn wdm_path(&self) -> &wdm::Path<MCL, MCC, MPL> {
        (&self.1).into()
    }
}

impl wdm::Keylike<MCL, MCC, MPL, SubspaceId> for (Path, SubspaceId) {
    fn wdm_subspace_id(&self) -> &SubspaceId {
        &self.1
    }

    fn wdm_path(&self) -> &wdm::Path<MCL, MCC, MPL> {
        (&self.0).into()
    }
}

/// Methods for working with [`Keylikes`](Keylike).
///
/// This trait is automatically implemented by all types implementing [`Keylike`].
pub trait KeylikeExt: wdm::KeylikeExt<MCL, MCC, MPL, SubspaceId> {
    /// Returns whether `self` and `other` describe equal keys, i.e., whether their [subspace ids](Keylike::subspace_id) and [paths](Keylike::path) are both equal.
    ///
    /// # Examples
    ///
    /// ```
    /// use willow25::prelude::*;
    ///
    /// assert!(
    ///     (SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_eq(&(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!("")))
    /// );
    /// assert!(
    ///     !(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_eq(&(SubspaceId::from([1; SUBSPACE_ID_WIDTH]), path!("")))
    /// );
    /// assert!(
    ///     !(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_eq(&(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!("/nope")))
    /// );
    /// ```
    fn key_eq<OtherKey>(&self, other: &OtherKey) -> bool
    where
        OtherKey: Keylike,
    {
        self.wdm_key_eq(other)
    }

    /// Returns whether `self` and `other` describe non-equal keys, i.e., whether their [subspace ids](Keylike::subspace_id) and [paths](Keylike::path) are not both equal.
    ///
    /// # Examples
    ///
    /// ```
    /// use willow25::prelude::*;
    ///
    /// assert!(
    ///     !(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_ne(&(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!("")))
    /// );
    /// assert!(
    ///     (SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_ne(&(SubspaceId::from([1; SUBSPACE_ID_WIDTH]), path!("")))
    /// );
    /// assert!(
    ///     (SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!(""))
    ///     .key_ne(&(SubspaceId::from([0; SUBSPACE_ID_WIDTH]), path!("/nope")))
    /// );
    /// ```
    fn key_ne<OtherKey>(&self, other: &OtherKey) -> bool
    where
        OtherKey: Keylike,
    {
        self.wdm_key_ne(other)
    }
}

impl<T> KeylikeExt for T where T: Keylike + ?Sized {}