Enum Address 

pub enum Address {
    SocketAddress(SocketAddr),
    DomainAddress(Box<str>, u16),
}

SOCKS5 Address Format

+------+----------+----------+
| ATYP | DST.ADDR | DST.PORT |
+------+----------+----------+
|  1   | Variable |    2     |
+------+----------+----------+

Variants

SocketAddress(SocketAddr)

Represents an IPv4 or IPv6 socket address.

DomainAddress(Box<str>, u16)

Represents a domain name and a port.

Implementations

impl Address

pub fn unspecified() -> Self

👎Deprecated since 0.10.3:

Use ‘unspecified_v4’ instead

Returns an unspecified IPv4 address (0.0.0.0:0).

pub fn unspecified_v4() -> Self

Returns an unspecified IPv4 address (0.0.0.0:0).

pub fn unspecified_v6() -> Self

Returns an unspecified IPv6 address (::0:0).

pub fn get_type(&self) -> AddressType

Returns the type of the address (IPv4, IPv6, or Domain).

pub fn port(&self) -> u16

Returns the port number.

pub fn host(&self) -> String

Returns the host name or IP address as a string.

pub fn domain(&self) -> String

👎Deprecated:

use host() instead

Returns the host name or IP address as a string.

pub fn is_ipv4(&self) -> bool

Returns true if it is an IPv4 address.

pub fn is_ipv6(&self) -> bool

Returns true if it is an IPv6 address.

pub fn is_domain(&self) -> bool

Returns true if it is a domain address.

pub const fn max_serialized_len() -> usize

Returns the maximum possible serialized length of a SOCKS5 address.

pub async fn resolve_using_tokio(&self) -> Result<IntoIter<SocketAddr>>

Resolves the address using Tokio’s asynchronous DNS resolution. Returns an iterator over the resolved socket addresses.

pub async fn resolve_tokio(&self) -> Result<IntoIter<SocketAddr>>

👎Deprecated since 0.10.3:

Use ‘resolve_using_tokio’ instead.

pub fn resolve(&self) -> Result<IntoIter<SocketAddr>>

Resolves the address using the standard library’s DNS resolution. Returns an iterator over the resolved socket addresses.

Errors

Returns an std::io::Error if address resolution fails.

Examples

let addr = socks5_impl::Address::from(("www.qq.com", 80));
for socket_addr in addr.resolve().unwrap() {
    println!("Resolved address: {}", socket_addr);
}

let addr = socks5_impl::Address::from(("127.0.0.1", 8080));
for socket_addr in addr.resolve().unwrap() {
    println!("Resolved address: {}", socket_addr);
}

Trait Implementations

impl AsyncStreamOperation for Address

fn retrieve_from_async_stream<'life0, 'async_trait, R>( stream: &'life0 mut R, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where R: AsyncRead + Unpin + Send + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

fn write_to_async_stream<'life0, 'life1, 'async_trait, W>( &'life0 self, writer: &'life1 mut W, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where W: AsyncWrite + Unpin + Send + ?Sized + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Clone for Address

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Default for Address

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Address

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl Eq for Address

impl From<&Address> for String

fn from(addr: &Address) -> Self

Converts to this type from the input type.

impl From<&Address> for Address

fn from(addr: &Address) -> Self

Converts to this type from the input type.

impl From<&SocketAddr> for Address

fn from(addr: &SocketAddr) -> Self

Converts to this type from the input type.

impl From<(&String, u16)> for Address

fn from((addr, port): (&String, u16)) -> Self

Converts to this type from the input type.

impl From<(&str, u16)> for Address

fn from((addr, port): (&str, u16)) -> Self

Converts to this type from the input type.

impl From<(IpAddr, u16)> for Address

fn from((addr, port): (IpAddr, u16)) -> Self

Converts to this type from the input type.

impl From<(Ipv4Addr, u16)> for Address

fn from((addr, port): (Ipv4Addr, u16)) -> Self

Converts to this type from the input type.

impl From<(Ipv6Addr, u16)> for Address

fn from((addr, port): (Ipv6Addr, u16)) -> Self

Converts to this type from the input type.

impl From<(String, u16)> for Address

fn from((addr, port): (String, u16)) -> Self

Converts to this type from the input type.

impl From<Address> for String

fn from(addr: Address) -> Self

Converts to this type from the input type.

impl From<Address> for Vec<u8>

fn from(addr: Address) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for Address

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for Address

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 Address

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 Address

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Address

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Address

fn partial_cmp(&self, other: &Self) -> 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 Address

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StreamOperation for Address

fn retrieve_from_stream<R: Read>(stream: &mut R) -> Result<Self>

fn write_to_buf<B: BufMut>(&self, buf: &mut B)

fn len(&self) -> usize

fn write_to_stream<W: Write>(&self, writer: &mut W) -> Result<()>

fn is_empty(&self) -> bool

impl StructuralPartialEq for Address

impl ToSocketAddrs for Address

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 TryFrom<&Address> for SocketAddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(address: &Address) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&String> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(addr: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&[u8]> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(addr: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Address> for SocketAddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(address: Address) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(addr: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.