Struct erpc_scanner::relay::RelaysPool

pub struct RelaysPool<'a, T> {
    pub relays_hashmap: HashMap<String, (Relay<'a>, T)>,
}

RelaysPool stores the hashmap of Fingerprint of the Relay and the Relay itself and provides the abstraction to get the reference to the relay through the get_relay(fingerprint) method

The RelaysPool holds the hashmap of <RELAY_FINGERPRINT, tor_netdir::Relay>, so that the Tor Network graph stores only data enough to index the Relay i.e the RELAY_FINGERPRINT and whenever it needs some data related to a certain relay, it simply requests this pool a reference to the tor_netdir::Relay through get_relay(RELAY_FINGERPRINT) method where RELAY_FINGERPRINT is a string that represents the stringified RSA ID of the relay

Fields

relays_hashmap: HashMap<String, (Relay<'a>, T)>

Maps <Fingerprint, Relay>

Implementations

impl<'a, T: Clone> RelaysPool<'a, T>

pub fn empty() -> Self

Create empty RelaysPool

It basically makes the inner HashMap empty

pub fn from_relays(relays: &[(Relay<'a>, T)]) -> Self

Takes the NetDir and creaates a RelaysPool

Why not get Arc and build the RelaysPool directly from there? Well, it seems that when we take Arc as input parameter and get relays through Relay<’a>, the lifetime of the Relay is tied to this parameter itself and then we cannot send the RelaysPool we created out of this method

pub fn get_relay<S: AsRef<str>>( &self, fingerprint: S ) -> Option<&(Relay<'a>, T)>

Gets you the reference to the Relay as you provide the fingerprint of the relay

pub fn add_relay<S: ToString>(&mut self, fingerprint: S, relay: Relay<'a>, v: T)

Add a tor_netdir::Relay<'_> into the RelaysPool with a certain fingerprint as the key

pub fn total_relays(&self) -> usize

Calculate total no of Relays in the RelaysPool