Struct HsDirs 

pub(crate) struct HsDirs<D> {
    pub(crate) current: D,
    pub(crate) secondary: Vec<D>,
}

Available on crate feature hs-common only.

Collection of hidden service directories (or parameters for them)

In NetDir this is used to store the actual hash rings. (But, in a NetDir in a PartialNetDir, it contains HsDirRings where only the params are populated, and the ring is empty.)

This same generic type is used as the return type from HsDirParams::compute, where it contains the parameters for the primary and secondary rings.

Fields

current: D

The current ring

It corresponds to the time period containing the valid-after time in the consensus. Its SRV is whatever SRV was most current at the time when that time period began.

This is the hash ring that we should use whenever we are fetching an onion service descriptor.

secondary: Vec<D>

Available on crate feature hs-service only.

Secondary rings (based on the parameters for the previous and next time periods)

Onion services upload to positions on these ring as well, based on how far into the current time period this directory is, so that not-synchronized clients can still find their descriptor.

Note that with the current (2023) network parameters, with hsdir_interval = SRV lifetime = 24 hours at most one of these secondary rings will be active at a time. We have two here in order to conform with a more flexible regime in proposal 342.

Implementations

impl<D> HsDirs<D>

pub(crate) fn map<D2>(self, f: impl FnMut(D) -> D2) -> HsDirs<D2>

Convert an HsDirs<D> to HsDirs<D2> by mapping each contained D

pub(crate) fn iter_filter_secondary( &self, secondary: bool, ) -> impl Iterator<Item = &D>

Iterate over some of the contained hsdirs, according to secondary

The current ring is always included. Secondary rings are included iff secondary and the hs-service feature is enabled.

pub(crate) fn iter(&self) -> impl Iterator<Item = &D>

Iterate over all the contained hsdirs

pub(crate) fn iter_for_op(&self, op: HsDirOp) -> impl Iterator<Item = &D>

Iterate over the hsdirs relevant for op

Trait Implementations

impl<D: Clone> Clone for HsDirs<D>

fn clone(&self) -> HsDirs<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for HsDirs<D>

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

Formats the value using the given formatter.