Enum Location 

pub enum Location {
    Addr(ChannelAddr),
    Via(Uid, Box<Location>),
}

A network location.

Two variants: a terminal ChannelAddr, or a “via” hop carrying the Uid of a gateway through which the inner location is reachable. The via form is a source route — a message addressed to Via(uid, inner) is forwarded by the gateway holding that uid and then routed by the inner location.

Display syntax:

location := via* zmq-url
via      := uid "."
uid      := label | "<" base58 ">" | label "<" base58 ">"

The parser sniffs the ZMQ URL scheme (<scheme>://) to split the via list from the URL — so any uid form accepted by Uid (singleton label, unlabeled instance, or labeled instance) is admitted in via position.

Examples:

• <2MuAHeDjLCEd>.tcp://[::1]:2345 — one unlabeled instance via.
• host<7PDmJtQJB5S>.tcp://[::1]:2345 — labeled instance via.
• client.host<7PDmJtQJB5S>.tcp://[::1]:2345 — a singleton via stacked on a labeled instance via.

Variants

Addr(ChannelAddr)

A terminal channel address. Routed directly.

Via(Uid, Box<Location>)

A via hop: messages for this location are forwarded by the gateway holding Uid, which peels this prefix off the destination before routing the inner location.

Implementations

impl Location

pub fn is_addr(&self) -> bool

Returns true if this is a Location::Addr, otherwise false

pub fn as_addr_mut(&mut self) -> Option<&mut ChannelAddr>

Optionally returns mutable references to the inner fields if this is a Location::Addr, otherwise None

pub fn as_addr(&self) -> Option<&ChannelAddr>

Optionally returns references to the inner fields if this is a Location::Addr, otherwise None

pub fn into_addr(self) -> Result<ChannelAddr, Self>

Returns the inner fields if this is a Location::Addr, otherwise returns back the enum in the Err case of the result

pub fn is_via(&self) -> bool

Returns true if this is a Location::Via, otherwise false

pub fn as_via_mut(&mut self) -> Option<(&mut Uid, &mut Box<Location>)>

Optionally returns mutable references to the inner fields if this is a Location::Via, otherwise None

pub fn as_via(&self) -> Option<(&Uid, &Box<Location>)>

Optionally returns references to the inner fields if this is a Location::Via, otherwise None

pub fn into_via(self) -> Result<(Uid, Box<Location>), Self>

Returns the inner fields if this is a Location::Via, otherwise returns back the enum in the Err case of the result

impl Location

pub fn addr(&self) -> &ChannelAddr

Returns the innermost channel address, peeling all via hops.

pub fn with_via(self, uid: Uid) -> Self

Wrap this location in a via hop carrying uid. Vias act like a stack: the outermost (most recently added) hop is the first the receiving gateway peels off.

pub fn pop_via(self) -> Result<(Uid, Location), Location>

Pop the outermost via hop. Returns Ok((uid, inner)) when this is a Via, or Err(self) when it is a terminal Addr, so the caller can recover the unchanged location.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Location

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Location

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

Formats the value using the given formatter.

impl From<ChannelAddr> for Location

fn from(addr: ChannelAddr) -> Self

Converts to this type from the input type.

impl FromStr for Location

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Location

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Location

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Location

fn eq(&self, other: &Location) -> 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 PartialOrd for Location

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Location

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 Location

impl StructuralPartialEq for Location