Enum holochain::prelude::dependencies::kitsune_p2p_types::dht_arc::DhtArcRange

pub enum DhtArcRange<T = DhtLocation> {
    Empty,
    Full,
    Bounded(T, T),
}

A variant of DHT arc which is intentionally forgetful of the Agent’s location. This type is used in places where set logic (union and intersection) is performed on arcs, which splits and joins arcs in such a way that it doesn’t make sense to claim that the arc belongs to any particular agent or location.

This type exists to make sure we don’t accidentally intepret the starting point of such a “derived” arc as a legitimate agent location.

Variants

Empty

Full

Bounded(T, T)

Implementations

impl<T> DhtArcRange<T>

where T: PartialOrd + Num,

pub fn contains<B>(&self, t: B) -> bool

where B: Borrow<T>,

impl<T> DhtArcRange<T>

pub fn map<U, F>(self, f: F) -> DhtArcRange<U>

where F: Fn(T) -> U,

impl<T> DhtArcRange<T>

where T: AsPrimitive<u32>,

pub fn from_bounds(start: T, end: T) -> DhtArcRange

pub fn from_start_and_len(start: T, len: u64) -> DhtArcRange

pub fn from_start_and_half_len(start: T, half_len: u32) -> DhtArcRange

Convenience for our legacy code which defined arcs in terms of half-lengths rather than full lengths

pub fn new_generic(start: T, end: T) -> DhtArcRange<T>

impl DhtArcRange<u32>

pub fn canonical(self) -> DhtArcRange

impl DhtArcRange

pub fn new_empty() -> DhtArcRange

Constructor

pub fn to_bounds_grouped(&self) -> Option<(DhtLocation, DhtLocation)>

Represent an arc as an optional range of inclusive endpoints. If none, the arc length is 0

pub fn to_primitive_bounds_detached(&self) -> (Option<u32>, Option<u32>)

Same as to_bounds_grouped, but with the return type “inside-out”

pub fn is_empty(&self) -> bool

Check if this arc is empty.

pub fn is_full(&self) -> bool

Check if this arc is full.

pub fn is_bounded(&self) -> bool

Check if this arc is bounded.

pub fn dist(&self, tgt: u32) -> u32

Get the min distance to a location. Zero if Full, u32::MAX if Empty.

pub fn overlaps(&self, other: &DhtArcRange) -> bool

Check if arcs overlap

pub fn overlap_coverage(&self, other: &DhtArcRange) -> f64

Amount of intersection between two arcs

pub fn coverage(&self) -> f64

The percentage of the full circle that is covered by this arc.

pub fn length(&self) -> u64

pub fn half_length(&self) -> u32

pub fn to_ascii(&self, len: usize) -> String

Handy ascii representation of an arc, especially useful when looking at several arcs at once to get a sense of their overlap

pub fn print(&self, len: usize)

pub fn canonical(self) -> DhtArcRange

Trait Implementations

impl<T> Clone for DhtArcRange<T>

where T: Clone,

fn clone(&self) -> DhtArcRange<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DhtArcRange<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for DhtArcRange<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<DhtArcRange<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DhtArc> for DhtArcRange

fn from(a: &DhtArc) -> DhtArcRange

Converts to this type from the input type.

impl From<&DhtArcRange> for DhtArcSet

fn from(arc: &DhtArcRange) -> DhtArcSet

Converts to this type from the input type.

impl From<DhtArc> for DhtArcRange

fn from(a: DhtArc) -> DhtArcRange

Converts to this type from the input type.

impl From<DhtArcRange> for DhtArcSet

fn from(arc: DhtArcRange) -> DhtArcSet

Converts to this type from the input type.

impl<T> Hash for DhtArcRange<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for DhtArcRange<T>

where T: PartialEq,

fn eq(&self, other: &DhtArcRange<T>) -> 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<T> Serialize for DhtArcRange<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for DhtArcRange<T>

where T: Copy,

impl<T> Eq for DhtArcRange<T>

where T: Eq,

impl<T> StructuralEq for DhtArcRange<T>

impl<T> StructuralPartialEq for DhtArcRange<T>