Struct Relay

pub(crate) struct Relay<'a> {
    pub(crate) rs: &'a MdConsensusRouterStatus,
    pub(crate) md: &'a Microdesc,
    pub(crate) cc: Option<CountryCode>,
}

A view of a relay on the Tor network, suitable for building circuits.

Fields

rs: &'a MdConsensusRouterStatus

md: &'a Microdesc

cc: Option<CountryCode>

Implementations

impl<'a> Relay<'a>

pub fn low_level_details(&self) -> RelayDetails<'_>

Return a RelayDetails for this relay.

Callers should generally avoid using this information directly if they can; it’s better to use a higher-level function that exposes semantic information rather than these properties.

pub fn id(&self) -> &Ed25519Identity

Return the Ed25519 ID for this relay.

pub fn rsa_id(&self) -> &RsaIdentity

Return the RsaIdentity for this relay.

pub fn rs(&self) -> &MdConsensusRouterStatus

Return a reference to this relay’s “router status” entry in the consensus.

The router status entry contains information about the relay that the authorities voted on directly. For most use cases, you shouldn’t need them.

This function is only available if the crate was built with its experimental-api feature.

pub fn md(&self) -> &Microdesc

Return a reference to this relay’s “microdescriptor” entry in the consensus.

A “microdescriptor” is a synopsis of the information about a relay, used to determine its capabilities and route traffic through it. For most use cases, you shouldn’t need it.

This function is only available if the crate was built with its experimental-api feature.

Trait Implementations

impl<'a> ChanTarget for Relay<'a>

fn display_chan_target(&self) -> DisplayChanTarget<'_, Self>

where Self: Sized,

Return a reference to this object suitable for formatting its [ChanTarget]-specific members.

impl<'a> CircTarget for Relay<'a>

fn ntor_onion_key(&self) -> &PublicKey

Return the ntor onion key for this relay

fn protovers(&self) -> &Protocols

Return the subprotocols implemented by this relay.

fn linkspecs(&self) -> Result<Vec<EncodedLinkSpec>, EncodeError>

Return a new vector of encoded link specifiers for this relay.

impl<'a> Clone for Relay<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> HasAddrs for Relay<'a>

fn addrs(&self) -> &[SocketAddr]

Return the addresses listed for this server.

impl<'a> HasCountryCode for Relay<'a>

fn country_code(&self) -> Option<CountryCode>

Return the country code in which this server is most likely located.

impl<'a> HasRelayIdsLegacy for Relay<'a>

fn ed_identity(&self) -> &Ed25519Identity

Return the ed25519 identity for this relay.

fn rsa_identity(&self) -> &RsaIdentity

Return the RSA identity for this relay.

impl<'a> DirectChanMethodsHelper for Relay<'a>