Struct kitsune_p2p_dht::spacetime::Topology

pub struct Topology {
    pub space: SpaceDimension,
    pub time: TimeDimension,
    pub time_origin: Timestamp,
    pub time_cutoff: Duration,
}

Topology defines the structure of spacetime, in particular how space and time are quantized.

Any calculation which requires converting from absolute coordinates to quantized coordinates must refer to the topology. Therefore, this type is ubiquitous! More functions than not take it as a parameter. This may seem cumbersome, but there are a few reasons why this is helpful:

• We currently use a “standard” quantization for all networks, but we may find it beneficial in the future to let each network specify its own quantization levels, based on its own traffic and longevity needs.
• It is confusing to be working with three different coordinate systems in this codebase, and the presence of a &topo param in a function is a helpful reminder to be extra mindful about the unit conversions that are happening

Fields

space: SpaceDimension

The quantization of space

time: TimeDimension

The quantization of time

time_origin: Timestamp

The origin of time, meaning the 0th quantum contains this Timestamp.

time_cutoff: Duration

Ignore any data which lies after Timestamp::now() - time_cutoff. This is so that historical quantized gossip does not overlap with recent gossip.

Implementations

impl Topology

pub fn standard(time_origin: Timestamp, time_cutoff: Duration) -> Self

Standard dimensions with the given time origin

pub fn standard_epoch(time_cutoff: Duration) -> Self

Standard dimensions with the HOLOCHAIN_EPOCH as the time origin

pub fn standard_epoch_full() -> Self

Standard dimensions with the HOLOCHAIN_EPOCH as the time origin

pub fn space_quantum(&self, x: Loc) -> SpaceQuantum

Returns the space quantum which contains this location

pub fn time_quantum(&self, t: Timestamp) -> TimeQuantum

Returns the time quantum which contains this timestamp

pub fn time_quantum_duration(&self, d: Duration) -> TimeQuantum

Returns the time quantum which contains this timestamp

pub fn min_space_power(&self) -> u8

The minimum power to use in “exponentional coordinates”.

pub fn max_space_power(&self, strat: &ArqStrat) -> u8

The maximum power to use in “exponentional coordinates”. This is 17 for standard space topology. (32 - 12 - 3)

Trait Implementations

impl AsRef<SpaceDimension> for Topology

fn as_ref(&self) -> &SpaceDimension

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<TimeDimension> for Topology

fn as_ref(&self) -> &TimeDimension

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Topology

fn clone(&self) -> Topology

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Topology

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a Topology> for SpaceDimension

fn from(topo: &'a Topology) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Topology> for TimeDimension

fn from(topo: &'a Topology) -> Self

Converts to this type from the input type.

impl From<Topology> for SpaceDimension

fn from(topo: Topology) -> Self

Converts to this type from the input type.

impl From<Topology> for TimeDimension

fn from(topo: Topology) -> Self

Converts to this type from the input type.

impl PartialEq for Topology

fn eq(&self, other: &Topology) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Topology

impl StructuralPartialEq for Topology