Struct NymRouteProvider 

pub struct NymRouteProvider {
    pub topology: NymTopology,
    pub ignore_egress_epoch_roles: bool,
}

Fields

topology: NymTopology

ignore_egress_epoch_roles: bool

Allow constructing routes with final hop at nodes that are not entry/exit gateways in the current epoch

Implementations

impl NymRouteProvider

pub fn new( topology: NymTopology, ignore_egress_epoch_roles: bool, ) -> NymRouteProvider

pub fn current_key_rotation(&self) -> u32

pub fn absolute_epoch_id(&self) -> u32

pub fn metadata(&self) -> NymTopologyMetadata

pub fn new_empty(ignore_egress_epoch_roles: bool) -> NymRouteProvider

pub fn update(&mut self, new_topology: NymTopology)

pub fn clear_topology(&mut self)

pub fn with_ignore_egress_epoch_roles( self, ignore_egress_epoch_roles: bool, ) -> NymRouteProvider

pub fn ignore_egress_epoch_roles(&mut self, ignore_egress_epoch_roles: bool)

pub fn egress_by_identity( &self, node_identity: PublicKey, ) -> Result<&RoutingNode, NymTopologyError>

pub fn node_by_identity(&self, node_identity: PublicKey) -> Option<&RoutingNode>

pub fn random_route_to_egress<R>( &self, rng: &mut R, egress_identity: PublicKey, ) -> Result<Vec<Node>, NymTopologyError>

where R: Rng + CryptoRng + ?Sized,

Tries to create a route to the egress point, such that it goes through mixnode on layer 1, mixnode on layer2, …. mixnode on layer n and finally the target egress, which can be any known node

pub fn empty_route_to_egress( &self, egress_identity: PublicKey, ) -> Result<Vec<Node>, NymTopologyError>

Returns a route directly to the egress point, which can be any known node

pub fn random_path_to_egress<R>( &self, rng: &mut R, egress_identity: PublicKey, ) -> Result<(Vec<&RoutingNode>, &RoutingNode), NymTopologyError>

where R: Rng + CryptoRng + ?Sized,

Trait Implementations

impl Clone for NymRouteProvider

fn clone(&self) -> NymRouteProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NymRouteProvider

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

Formats the value using the given formatter.

impl Default for NymRouteProvider

fn default() -> NymRouteProvider

Returns the “default value” for a type.

impl From<NymTopology> for NymRouteProvider

fn from(topology: NymTopology) -> NymRouteProvider

Converts to this type from the input type.