Struct RelayRestriction

pub struct RelayRestriction<'a> {
    inner: RestrictionInner<'a>,
}

A restriction that we use when picking relays.

Differs from RelayUsage in that it does not say what the relay is used for; instead, it describes an additional set of requirements that a relay must satisfy.

Fields

inner: RestrictionInner<'a>

The actual restriction object.

Implementations

impl<'a> RelayRestriction<'a>

pub(crate) fn no_restriction() -> Self

Create a restriction that allows every relay.

pub(crate) fn for_usage(usage: RelayUsage) -> Self

Convert a usage into a restriction.

This is crate-internal since we never want to support requiring a relay to provide multiple usages.

pub fn require_country_code(cc: CountryCode) -> Self

Available on crate feature geoip only.

Require a relay that appears to be in the provided country, according ot our geoip subsystem.

pub fn require_address(addr_patterns: Vec<AddrPortPattern>) -> Self

Require that a relay has at least one address listed in addr_patterns.

pub(crate) fn relax(&self) -> Self

Return a restriction that represents having “relaxed” this restriction.

(Relaxing a restriction replaces it with a no-op, or with an almost-no-op.)

pub(crate) fn as_usage(&self) -> Option<&RelayUsage>

If this restriction represents a usage, return a reference to that usage.

pub(crate) fn rejection_description(&self) -> Option<&'static str>

Return a string describing why we rejected the relays that don’t match this restriction.

Trait Implementations

impl<'a> Clone for RelayRestriction<'a>

fn clone(&self) -> RelayRestriction<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RelayRestriction<'a>

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

Formats the value using the given formatter.

impl<'a> From<RelayExclusion<'a>> for RelayRestriction<'a>

fn from(value: RelayExclusion<'a>) -> Self

Converts to this type from the input type.

impl<'a> LowLevelRelayPredicate for RelayRestriction<'a>

fn low_level_predicate_permits_relay(&self, relay: &Relay<'_>) -> bool

Return true if relay provides this predicate.