Struct tor_netdoc::types::family::RelayFamily

pub struct RelayFamily(/* private fields */);

Information about a relay family.

Tor relays may declare that they belong to the same family, to indicate that they are controlled by the same party or parties, and as such should not be used in the same circuit. Two relays belong to the same family if and only if each one lists the other as belonging to its family.

NOTE: when parsing, this type always discards incorrectly-formatted entries, including entries that are only nicknames.

TODO: This type probably belongs in a different crate.

Implementations

impl RelayFamily

pub fn new() -> Self

Return a new empty RelayFamily.

pub fn push(&mut self, rsa_id: RsaIdentity)

Add rsa_id to this family.

pub fn intern(self) -> Arc<Self>

Consume this family, and return a new canonical interned representation of the family.

pub fn contains(&self, rsa_id: &RsaIdentity) -> bool

Does this family include the given relay?

pub fn members(&self) -> impl Iterator<Item = &RsaIdentity>

Return an iterator over the RSA identity keys listed in this family.

pub fn is_empty(&self) -> bool

Return true if this family has no members.

Trait Implementations

impl Clone for RelayFamily

fn clone(&self) -> RelayFamily

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayFamily

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

Formats the value using the given formatter.

impl Default for RelayFamily

fn default() -> RelayFamily

Returns the “default value” for a type.

impl FromStr for RelayFamily

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for RelayFamily

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RelayFamily

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RelayFamily

impl StructuralPartialEq for RelayFamily