Store trait

data-model/src/lengthy_entry.rs

@@ -0,0 +1,122 @@
+use crate::{AuthorisationToken, AuthorisedEntry, Entry, NamespaceId, PayloadDigest, SubspaceId};
+
+/// An [`Entry`] together with information about how much of its payload a given [`Store`] holds.
+///
+/// [Definition](https://willowprotocol.org/specs/3d-range-based-set-reconciliation/index.html#LengthyEntry)
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct LengthyEntry<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD>
+where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+{
+    /// 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>
+where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+{
+    /// Create 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 }
+    }
+
+    /// The entry in question.
+    pub fn entry(&self) -> &Entry<MCL, MCC, MPL, N, S, PD> {
+        &self.entry
+    }
+
+    /// The number of consecutive bytes from the start of the entry’s Payload that the peer holds.
+    pub fn available(&self) -> u64 {
+        self.available
+    }
+
+    /// Turn 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>
+where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+{
+    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 [`Store`] holds.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct LengthyAuthorisedEntry<
+    const MCL: usize,
+    const MCC: usize,
+    const MPL: usize,
+    N,
+    S,
+    PD,
+    AT,
+> where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+    AT: AuthorisationToken<MCL, MCC, MPL, N, S, PD>,
+{
+    /// 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>
+where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+    AT: AuthorisationToken<MCL, MCC, MPL, N, S, PD>,
+{
+    /// Create 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 }
+    }
+
+    /// The entry in question.
+    pub fn entry(&self) -> &AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT> {
+        &self.entry
+    }
+
+    /// The number of consecutive bytes from the start of the entry’s Payload that the peer holds.
+    pub fn available(&self) -> u64 {
+        self.available
+    }
+
+    /// Turn 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>
+where
+    N: NamespaceId,
+    S: SubspaceId,
+    PD: PayloadDigest,
+    AT: AuthorisationToken<MCL, MCC, MPL, N, S, PD>,
+{
+    fn as_ref(&self) -> &AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT> {
+        &self.entry
+    }
+}

data-model/src/lib.rs

@@ -27,9 +27,13 @@
 
 mod entry;
 pub use entry::*;
+mod lengthy_entry;
+pub use lengthy_entry::*;
 pub mod grouping;
 mod parameters;
 pub use parameters::*;
 mod path;
 pub use path::*;
 mod relative_encodings;
+mod store;
+pub use store::*;