Enum DestinationRouting 

pub enum DestinationRouting {
    Forward {
        destination: Box<NodeId>,
        pseudonym: Option<HoprPseudonym>,
        forward_options: RoutingOptions,
        return_options: Option<RoutingOptions>,
    },
    Return(SurbMatcher),
}

Routing information containing forward or return routing options.

Information in this object represents the minimum required basis to generate forward paths and return paths.

See also RoutingOptions.

Variants

Forward

Forward routing using the destination node and path, with a possible return path.

Fields

destination: Box<NodeId>

The destination node.

pseudonym: Option<HoprPseudonym>

Our pseudonym shown to the destination.

If not given, it will be resolved as random.

forward_options: RoutingOptions

The path to the destination.

return_options: Option<RoutingOptions>

Optional return path.

Return(SurbMatcher)

Return routing using a SURB with the given pseudonym.

Will fail if no SURB for this pseudonym is found.

Implementations

impl DestinationRouting

pub const fn is_forward(&self) -> bool

Returns true if the enum is DestinationRouting::Forward otherwise false

pub const fn is_return(&self) -> bool

Returns true if the enum is DestinationRouting::Return otherwise false

impl DestinationRouting

pub fn forward_only<T: Into<NodeId>>( destination: T, forward_options: RoutingOptions, ) -> Self

Shortcut for routing that does not create any SURBs for a return path.

Trait Implementations

impl Clone for DestinationRouting

fn clone(&self) -> DestinationRouting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DestinationRouting

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DestinationRouting

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DestinationRouting

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DestinationRouting

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DestinationRouting

impl StructuralPartialEq for DestinationRouting