willow-data-model 0.2.0

The datatypes of Willow, an eventually consistent data store with improved distributed deletion.
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

use crate::{AuthorisedEntry, Entry};

/// An [`Entry`] together with information about how much of its payload a given [`crate::Store`] holds.
///
/// [Definition](https://willowprotocol.org/specs/3d-range-based-set-reconciliation/index.html#LengthyEntry)
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct LengthyEntry<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD> {
    /// The Entry in question.
    entry: Entry<MCL, MCC, MPL, N, S, PD>,
    /// The number of consecutive bytes from the start of the entry’s payload that the peer holds.
    available: u64,
}

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD>
    LengthyEntry<MCL, MCC, MPL, N, S, PD>
{
    /// Returns a new lengthy entry from a given [`Entry`] and the number of consecutive bytes from the start of the entry’s payload that are held.
    pub fn new(entry: Entry<MCL, MCC, MPL, N, S, PD>, available: u64) -> Self {
        Self { entry, available }
    }

    /// Returns the entry in question.
    pub fn entry(&self) -> &Entry<MCL, MCC, MPL, N, S, PD> {
        &self.entry
    }

    /// Returns the number of consecutive bytes from the start of the entry’s Payload that the peer holds.
    pub fn available(&self) -> u64 {
        self.available
    }

    /// Turns this into a regular [`Entry`].
    pub fn into_entry(self) -> Entry<MCL, MCC, MPL, N, S, PD> {
        self.entry
    }
}

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD>
    AsRef<Entry<MCL, MCC, MPL, N, S, PD>> for LengthyEntry<MCL, MCC, MPL, N, S, PD>
{
    fn as_ref(&self) -> &Entry<MCL, MCC, MPL, N, S, PD> {
        &self.entry
    }
}

/// An [`AuthorisedEntry`] together with information about how much of its payload a given [`crate::Store`] holds.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct LengthyAuthorisedEntry<
    const MCL: usize,
    const MCC: usize,
    const MPL: usize,
    N,
    S,
    PD,
    AT,
> {
    /// The Entry in question.
    entry: AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>,
    /// The number of consecutive bytes from the start of the entry’s payload that the peer holds.
    available: u64,
}

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT>
    LengthyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>
{
    /// Returns a new lengthy entry from a given [`AuthorisedEntry`] and the number of consecutive bytes from the start of the entry’s payload that are held.
    pub fn new(entry: AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>, available: u64) -> Self {
        Self { entry, available }
    }

    /// Returns the authorised entry in question.
    pub fn entry(&self) -> &AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT> {
        &self.entry
    }

    /// Returns the number of consecutive bytes from the start of the entry’s Payload that the peer holds.
    pub fn available(&self) -> u64 {
        self.available
    }

    /// Turns this into a [`AuthorisedEntry`].
    pub fn into_authorised_entry(self) -> AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT> {
        self.entry
    }
}

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT>
    AsRef<AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>>
    for LengthyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>
{
    fn as_ref(&self) -> &AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT> {
        &self.entry
    }
}