Struct OnionRouteRequest 

pub struct OnionRouteRequest {
    pub service: OnionServiceName,
    pub hop_count: usize,
    pub allow_short_paths: bool,
}

Route-building request for an onion circuit.

Fields

service: OnionServiceName

Exit service required by the route.

hop_count: usize

Desired hop count including the exit. 0 uses DEFAULT_ONION_ROUTE_HOPS.

allow_short_paths: bool

Whether a route may be shorter than hop_count when the network is too small.

Implementations

impl OnionRouteRequest

pub fn new( service: impl AsRef<str>, hop_count: usize, allow_short_paths: bool, ) -> Result<Self>

Build a route request from an untrusted service string.

pub fn from_service_name( service: OnionServiceName, hop_count: usize, allow_short_paths: bool, ) -> Self

Build a route request from an already canonical service name.

pub fn service(&self) -> &str

Return the canonical service selected by this request.

Trait Implementations

impl Clone for OnionRouteRequest

fn clone(&self) -> OnionRouteRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnionRouteRequest

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

Formats the value using the given formatter.

impl Eq for OnionRouteRequest

impl PartialEq for OnionRouteRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OnionRouteRequest