Struct VanguardSets 

pub(super) struct VanguardSets {
    l2_vanguards: VanguardSet,
    l3_vanguards: VanguardSet,
}

The L2 and L3 vanguard sets, stored in the same struct to simplify serialization.

Fields

l2_vanguards: VanguardSet

The L2 vanguard sets.

l3_vanguards: VanguardSet

The L3 vanguard sets.

Only used if full vanguards are enabled.

Implementations

impl VanguardSets

pub(super) fn next_expiry(&self) -> Option<SystemTime>

Find the timestamp of the vanguard that is due to expire next.

pub(super) fn l2(&self) -> &VanguardSet

Return a reference to the L2 VanguardSet.

pub(super) fn l3(&self) -> &VanguardSet

Return a reference to the L3 VanguardSet.

pub(super) fn remove_expired(&mut self, now: SystemTime) -> usize

Remove the vanguards that are expired at the specified timestamp.

Returns the number of vanguards that were removed.

pub(super) fn remove_unlisted(&mut self, netdir: &NetDir)

Remove the vanguards that are no longer listed in netdir.

Returns whether either of the two sets have changed.

pub(super) fn replenish_vanguards<R: Runtime>( &mut self, runtime: &R, netdir: &NetDir, params: &VanguardParams, mode: VanguardMode, ) -> Result<(), VanguardMgrError>

Replenish the vanguard sets if necessary, using the directory information from the specified NetDir.

Note: the L3 set is only replenished if Full vanguards are enabled.

fn replenish_set<R: Runtime, Rng: RngCore>( runtime: &R, rng: &mut Rng, netdir: &NetDir, vanguard_set: &mut VanguardSet, min_lifetime: Duration, max_lifetime: Duration, ) -> Result<bool, VanguardMgrError>

Replenish a single VanguardSet with however many vanguards it is short of.

fn add_n_vanguards<R: Runtime, Rng: RngCore>( runtime: &R, rng: &mut Rng, netdir: &NetDir, n: usize, exclude: RelayExclusion<'_>, min_lifetime: Duration, max_lifetime: Duration, ) -> Result<Vec<TimeBoundVanguard>, VanguardMgrError>

Select n relays to use as vanguards.

Each selected vanguard will have a random lifetime between min_lifetime and max_lifetime.

Trait Implementations

impl Clone for VanguardSets

fn clone(&self) -> VanguardSets

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VanguardSets

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

Formats the value using the given formatter.

impl Default for VanguardSets

fn default() -> VanguardSets

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VanguardSets

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VanguardSets

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for VanguardSets

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VanguardSets