Struct UniAddr 

pub struct UniAddr { /* private fields */ }

A unified address type that can represent:

• std::net::SocketAddr
• unix::SocketAddr (a wrapper over std::os::unix::net::SocketAddr)
• A host name with port. See ToSocketAddrs.

Parsing Behaviour

• Checks if the address started with UNIX_URI_PREFIX: parse as a UDS address.
• Checks if the address is started with a alphabetic character (a-z, A-Z): treat as a host name. Notes that we will not validate if the host name is valid.
• Tries to parse as a network socket address.
• Otherwise, treats the input as a host name.

Implementations

impl UniAddr

pub const fn as_inner(&self) -> &UniAddrInner

Returns a reference to the inner value.

impl UniAddr

pub fn new(addr: &str) -> Result<Self, ParseError>

Creates a new UniAddr from its string representation.

Errors

Not a valid address string.

pub fn new_host( addr: &str, parsed: Option<(&str, u16)>, ) -> Result<Self, ParseError>

Creates a new UniAddr from a string containing a host name and port, like example.com:8080.

Errors

• ParseError::InvalidHost if the host name is invalid.
• ParseError::InvalidPort if the port is invalid.

pub fn blocking_resolve_socket_addrs(&mut self) -> Result<()>

Resolves the address if it is a host name.

By default, we utilize the method ToSocketAddrs::to_socket_addrs provided by the standard library to perform DNS resolution, which is a blocking operation and may take an arbitrary amount of time to complete, use with caution when called in asynchronous contexts.

Errors

Resolution failure, or if no socket address resolved.

pub fn blocking_resolve_socket_addrs_with<F, A>(&mut self, f: F) -> Result<()>

where F: FnOnce(&str) -> Result<A>, A: Iterator<Item = SocketAddr>,

Resolves the address if it is a host name using a custom resolver function.

Errors

Resolution failure, or if no socket address resolved.

pub async fn resolve_socket_addrs(&mut self) -> Result<()>

Asynchronously resolves the address if it is a host name.

This method will spawn a blocking Tokio task to perform the resolution using ToSocketAddrs::to_socket_addrs provided by the standard library.

Errors

Resolution failure, or if no socket address resolved.

pub fn to_str(&self) -> Cow<'_, str>

Serializes the address to a string.

Methods from Deref<Target = UniAddrInner>

pub fn to_str(&self) -> Cow<'_, str>

Serializes the address to a string.

Trait Implementations

impl AsRef<UniAddrInner> for UniAddr

fn as_ref(&self) -> &UniAddrInner

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UniAddr

fn clone(&self) -> UniAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UniAddr

where UniAddrInner: Debug,

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

Formats the value using the given formatter.

impl Deref for UniAddr

type Target = UniAddrInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for UniAddr

Available on crate feature feat-serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UniAddr

where UniAddrInner: Display,

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

Formats the value using the given formatter.

impl From<SocketAddr> for UniAddr

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for UniAddr

Available on Unix only.

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for UniAddr

Available on Unix and crate feature feat-tokio only.

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for UniAddr

Available on Unix only.

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for UniAddr

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for UniAddr

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 PartialEq for UniAddr

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

Available on crate feature feat-serde only.

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 UniAddr

impl StructuralPartialEq for UniAddr