Struct BridgeSet

pub(crate) struct BridgeSet {
    config: Arc<[BridgeConfig]>,
    descs: Option<Arc<BridgeDescList>>,
}

Available on crate feature bridge-client only.

A collection of bridges, possibly with their descriptors.

Fields

config: Arc<[BridgeConfig]>

The configured bridges.

descs: Option<Arc<BridgeDescList>>

A map from those bridges to their descriptors. It may contain elements that are not in config.

Implementations

impl BridgeSet

pub(crate) fn new( config: Arc<[BridgeConfig]>, descs: Option<Arc<BridgeDescList>>, ) -> Self

Create a new BridgeSet from its configuration.

pub(crate) fn bridge_by_guard<T>(&self, guard: &T) -> Option<&BridgeConfig>

where T: ChanTarget,

Returns the bridge that best matches a given guard.

Note that since the guard may have more identities than the bridge the match may not be perfect: the caller needs to check for a closer match if they want to be certain.

We check for a match by identity and channel method, since channel method is part of what makes two bridge lines different.

fn relay_by_bridge<'a>(&'a self, bridge: &'a BridgeConfig) -> BridgeRelay<'a>

Return a BridgeRelay wrapping the provided configuration, plus any known descriptor for that configuration.

pub(crate) fn bridge_relay_by_guard<T: ChanTarget>( &self, guard: &T, ) -> CandidateStatus<BridgeRelay<'_>>

Look up a BridgeRelay corresponding to a given guard.

Trait Implementations

impl Clone for BridgeSet

fn clone(&self) -> BridgeSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeSet

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

Formats the value using the given formatter.

impl Universe for BridgeSet

fn weight_threshold<T>( &self, _sample: &ByRelayIds<T>, _params: &GuardParams, ) -> WeightThreshold

where T: HasRelayIds,

Note that for a BridgeSet, we always treat the current weight as 0 and the maximum weight as “unlimited”. That’s because we don’t have bandwidth measurements for bridges, and so max_sample_bw_fraction doesn’t apply to them.

fn contains<T: ChanTarget>(&self, guard: &T) -> Option<bool>

Check whether this universe contains a candidate for the given guard.

fn status<T: ChanTarget>(&self, guard: &T) -> CandidateStatus<Candidate>

Return full information about a member of this universe for a given guard.

fn timestamp(&self) -> SystemTime

Return an (approximate) timestamp describing when this universe was generated.

fn sample<T>( &self, pre_existing: &ByRelayIds<T>, filter: &GuardFilter, n: usize, ) -> Vec<(Candidate, RelayWeight)>

where T: HasRelayIds,

Return up to n of new candidate guards from this Universe.