Struct PartialNetDir

pub struct PartialNetDir {
    pub(crate) netdir: NetDir,
    pub(crate) prev_netdir: Option<Arc<NetDir>>,
}

A partially build NetDir – it can’t be unwrapped until it has enough information to build safe paths.

Fields

netdir: NetDir

The netdir that’s under construction.

prev_netdir: Option<Arc<NetDir>>

Available on crate feature hs-common only.

The previous netdir, if we had one

Used as a cache, so we can reuse information

Implementations

impl PartialNetDir

pub fn new( consensus: MdConsensus, replacement_params: Option<&NetParams<i32>>, ) -> Self

Create a new PartialNetDir with a given consensus, and no microdescriptors loaded.

If replacement_params is provided, override network parameters from the consensus with those from replacement_params.

pub fn new_with_geoip( consensus: MdConsensus, replacement_params: Option<&NetParams<i32>>, geoip_db: &GeoipDb, ) -> Self

Available on crate feature geoip only.

Create a new PartialNetDir with GeoIP support.

This does the same thing as new(), except the provided GeoIP database is used to add country codes to relays.

pub(crate) fn new_inner( consensus: MdConsensus, replacement_params: Option<&NetParams<i32>>, geoip_db: Option<&GeoipDb>, ) -> Self

Implementation of the new() functions.

pub fn lifetime(&self) -> &Lifetime

Return the declared lifetime of this PartialNetDir.

pub fn fill_from_previous_netdir(&mut self, prev: Arc<NetDir>)

Record a previous netdir, which can be used for reusing cached information

pub(crate) fn compute_rings(&mut self)

Available on crate feature hs-common only.

Compute the hash ring(s) for this NetDir

pub fn have_enough_paths(&self) -> bool

Return true if this are enough information in this directory to build multihop paths.

pub fn unwrap_if_sufficient(self) -> Result<NetDir, PartialNetDir>

If this directory has enough information to build multihop circuits, return it.

Trait Implementations

impl Clone for PartialNetDir

fn clone(&self) -> PartialNetDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialNetDir

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

Formats the value using the given formatter.

impl MdReceiver for PartialNetDir

fn missing_microdescs(&self) -> Box<dyn Iterator<Item = &MdDigest> + '_>

Return an iterator over the digests for all of the microdescriptors that this netdir is missing.

fn add_microdesc(&mut self, md: Microdesc) -> bool

Add a microdescriptor to this netdir, if it was wanted.

fn n_missing(&self) -> usize

Return the number of missing microdescriptors.