Struct ockam_core::Route

pub struct Route { /* fields omitted */ }

A full route to a peer

Implementations

impl Route

pub fn new() -> RouteBuilder<'static>

Create an empty RouteBuilder

pub fn parse<S: Into<String>>(s: S) -> Option<Route>

Parse a route from a string

pub fn modify(&mut self) -> RouteBuilder<'_>

Create a new RouteBuilder from the current Route

pub fn step(&mut self) -> Result<Address>

Get the next item from this route

pub fn next(&self) -> Result<&Address>

Get the next item from this route without removing it

pub fn recipient(&self) -> Address

Get the final recipient address

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Route

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Route

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

Formats the value using the given formatter.

impl Eq for Route

impl From<RouteBuilder<'_>> for Route

fn from(_: RouteBuilder<'_>) -> Self

Performs the conversion.

impl<T: Into<Address>> From<T> for Route

fn from(t: T) -> Self

Performs the conversion.

impl Hash for Route

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Route

fn cmp(&self, other: &Route) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Route> for Route

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Route> for Route

fn partial_cmp(&self, other: &Route) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Route

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Route

impl StructuralPartialEq for Route