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

//! Defines the trait which represents everything Kitsune needs to know about Ops

use crate::{
    region::RegionData,
    spacetime::{SpacetimeQuantumCoords, Topology},
};

pub use kitsune_p2p_dht_arc::DhtLocation as Loc;

pub use kitsune_p2p_timestamp::Timestamp;

/// Everything that Kitsune needs to know about an Op.
/// Intended to be implemented by the host.
pub trait OpRegion<D = RegionData>: PartialOrd + Ord + Send + Sync + std::fmt::Debug {
    /// The op's Location
    fn loc(&self) -> Loc;
    /// The op's Timestamp
    fn timestamp(&self) -> Timestamp;
    /// The RegionData that would be produced if this op were the only op
    /// in the region. The sum of these produces the RegionData for the whole
    /// region.
    fn region_data(&self) -> D;

    /// The quantized space and time coordinates, based on the location and timestamp.
    fn coords(&self, topo: &Topology) -> SpacetimeQuantumCoords {
        SpacetimeQuantumCoords {
            space: topo.space_quantum(self.loc()),
            time: topo.time_quantum(self.timestamp()),
        }
    }

    /// Create an Op with arbitrary data but that has the given timestamp and location.
    /// Used for bounded range queries based on the PartialOrd impl of the op.
    fn bound(timestamp: Timestamp, loc: Loc) -> Self;
}