Struct kitsune_p2p_dht_arc::DhtArc

pub struct DhtArc(_, _);

The main DHT arc type. Represents an Agent’s storage Arc on the DHT, preserving the agent’s DhtLocation even in the case of a Full or Empty arc. Contrast to DhtArcRange, which is used for cases where the arc is not associated with any particular Agent, and so the agent’s Location cannot be known.

Implementations

impl DhtArc

pub fn bounded(a: DhtArcRange) -> Self

pub fn empty(loc: DhtLocation) -> Self

pub fn full(loc: DhtLocation) -> Self

pub fn start_loc(&self) -> DhtLocation

pub fn update_length<V: Into<PeerView>>(&mut self, view: V)

Update the half length based on a PeerView reading. This will converge on a new target instead of jumping directly to the new target and is designed to be called at a given rate with more recent peer views.

pub fn inner(self) -> DhtArcRange

pub fn from_parts(a: DhtArcRange, loc: DhtLocation) -> Self

Construct from an arc range and a location. The location is only used if the arc range is full or empty.

pub fn from_start_and_half_len<L: Into<DhtLocation>>(
    start: L,
    half_len: u32
) -> Self

pub fn from_start_and_len<L: Into<DhtLocation>>(start: L, len: u64) -> Self

pub fn from_bounds<L: Into<DhtLocation>>(start: L, end: L) -> Self

pub fn range(&self) -> ArcRange

Get the range of the arc

Methods from Deref<Target = DhtArcRange>

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

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 overlaps(&self, other: &Self) -> bool

Check if arcs overlap

pub fn overlap_coverage(&self, other: &Self) -> 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

Trait Implementations

impl Clone for DhtArc

fn clone(&self) -> DhtArc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DhtArc

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

Formats the value using the given formatter.

impl Deref for DhtArc

type Target = DhtArcRange

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for DhtArc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<&'_ DhtArc> for DhtArcRange

fn from(a: &DhtArc) -> Self

Converts to this type from the input type.

impl From<DhtArc> for DhtArcRange

fn from(a: DhtArc) -> Self

Converts to this type from the input type.

impl Serialize for DhtArc

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

Serialize this value into the given Serde serializer.

impl Copy for DhtArc