Struct StackAddr 

pub struct StackAddr { /* private fields */ }

A stack address that contains a stack of protocols. The stack address can be used to represent a network address with multiple protocols.

Implementations

impl StackAddr

pub fn new(segments: Vec<Segment>) -> Self

Create a new StackAddr with the given segments.

pub fn from_parts(segments: &[Segment]) -> Self

Create a new StackAddr from a slice of segments.

pub fn empty() -> Self

Create a new StackAddr with no segments.

pub fn with(self, segment: Segment) -> Self

Create a new StackAddr with a single segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_protocol(self, protocol: Protocol) -> Self

Create a new StackAddr with a single protocol segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_identity(self, identity: Identity) -> Self

Create a new StackAddr with a single identity segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_path(self, path: &str) -> Self

Create a new StackAddr with a single path segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_meta(self, key: &str, value: &str) -> Self

Create a new StackAddr with a single metadata segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_mac(self, addr: MacAddr) -> Self

Create a new StackAddr with a MAC address segment. This is a convenience method for creating a stack address with builder pattern.

pub fn try_with_mac_str(self, addr: &str) -> Result<Self, StackAddrError>

Create a new StackAddr with a MAC address segment from a string.

pub fn with_ipv4(self, addr: Ipv4Addr) -> Self

Create a new StackAddr with an IPv4 address segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_ipv6(self, addr: Ipv6Addr) -> Self

Create a new StackAddr with an IPv6 address segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_ip(self, addr: IpAddr) -> Self

Create a new StackAddr with an IP address segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_dns_name(self, name: &str) -> Self

Create a new StackAddr with a DNS name segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_dns4_name(self, name: &str) -> Self

Create a new StackAddr with a DNS4 name segment. This is a convenience method for creating a stack address with builder pattern.

pub fn with_dns6_name(self, name: &str) -> Self

Create a new StackAddr with a DNS6 name segment. This is a convenience method for creating a stack address with builder pattern.

pub fn segments(&self) -> &[Segment]

Returns a reference to the ordered list of segments that make up this stack address.

pub fn push(&mut self, segment: Segment)

Push a new segment to the stack address.

pub fn pop(&mut self) -> Option<Segment>

Pop the last segment from the stack address.

pub fn contains(&self, target: &Segment) -> bool

Check if the stack address contains a specific segment.

pub fn replace(&mut self, old: &Segment, new: Segment) -> bool

Replace the first occurrence of a segment with a new segment.

pub fn replace_all(&mut self, old: &Segment, new: Segment) -> usize

Replace all occurrences of a segment with a new segment.

pub fn remove(&mut self, target: &Segment) -> bool

Remove the first occurrence of a segment from the stack address.

pub fn remove_all(&mut self, target: &Segment) -> usize

Remove all occurrences of a segment from the stack address.

pub fn protocols(&self) -> Vec<&Protocol>

Returns all Protocol segments in the stack address.

This filters out non-protocol segments such as identities, paths, and metadata.

pub fn transport(&self) -> Option<TransportProtocol>

Extract the transport protocol (if any) from the address.

pub fn mac(&self) -> Option<MacAddr>

Get the MAC address from the stack address.

pub fn ip(&self) -> Option<IpAddr>

pub fn port(&self) -> Option<u16>

Get the port number from the stack address.

pub fn socket_addr(&self) -> Option<SocketAddr>

Get the socket address from the stack address.

pub fn host_port(&self) -> Result<(String, u16), StackAddrError>

Get the host (IP or DNS) and port pair, returning an error when either is missing.

pub fn socket_addrs(&self) -> Result<Vec<SocketAddr>, StackAddrError>

Resolve the address into concrete SocketAddr values using the system resolver.

This helper makes it easy to hand a StackAddr directly to networking libraries that expect socket addresses or types implementing ToSocketAddrs. It will return an error when host or port information is missing, or if DNS resolution fails.

pub fn name(&self) -> Option<&str>

Get the DNS name from the stack address.

pub fn resolved(&self) -> bool

Check if the stack address is resolved. A stack address is considered resolved if it contains an IP address.

pub fn is_empty(&self) -> bool

Check if the stack address is empty.

pub fn get_ip(&self) -> Option<&Protocol>

Returns the first IP protocol segment (Ip4 or Ip6) if present.

pub fn get_dns(&self) -> Option<&Protocol>

Returns the first DNS protocol segment (Dns, Dns4, or Dns6) if present.

pub fn get_identity(&self) -> Option<&Identity>

Returns the first identity segment (NodeId, PeerId, UUID, or Custom) if present.

pub fn resolve(&mut self, ip_addr: IpAddr)

Replace Dns/Dns4/Dns6 protocol with Ip4 or Ip6 This is used to resolve the name to an IP address

Trait Implementations

impl Clone for StackAddr

fn clone(&self) -> StackAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StackAddr

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

Formats the value using the given formatter.

impl Display for StackAddr

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

Formats the value using the given formatter.

impl FromStr for StackAddr

type Err = StackAddrError

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 StackAddr

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 StackAddr

fn cmp(&self, other: &StackAddr) -> 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 StackAddr

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

fn partial_cmp(&self, other: &StackAddr) -> 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 ToSocketAddrs for StackAddr

type Iter = IntoIter<SocketAddr>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl Eq for StackAddr

impl StructuralPartialEq for StackAddr