Enum SocksAddress 

pub enum SocksAddress {
    Ip(SocketAddr),
    Domain {
        host: String,
        port: u16,
    },
    Custom {
        network: String,
        address: String,
    },
}

An RFC 1928 SOCKS address or LazyCat custom-network address.

Variants

Ip(SocketAddr)

Numeric IPv4 or IPv6 socket address.

Domain

Domain name and port resolved by the SOCKS server.

Fields

host: String

Domain name carried on the wire without DNS resolution.

port: u16

Destination port.

Custom

LazyCat custom network encoded into the SOCKS domain field.

Fields

network: String

Custom network identifier, such as unix.

address: String

Address interpreted by the custom network implementation.

Implementations

impl SocksAddress

pub fn domain(host: impl Into<String>, port: u16) -> Result<Self, Error>

Construct a domain address without resolving it locally.

Errors

Returns an error for an empty host or a host longer than 255 bytes.

pub fn custom( network: impl Into<String>, address: impl Into<String>, ) -> Result<Self, Error>

Construct a LazyCat custom-network address.

Errors

Returns an error for an empty network or when the encoded custom domain is longer than 255 bytes.

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode this address using the RFC 1928 wire representation.

Errors

Returns an error if a string address cannot fit in the one-byte length field.

pub fn decode(encoded: &[u8]) -> Result<Self, Error>

Decode exactly one RFC 1928 address.

Errors

Returns an error for truncated data, trailing bytes, invalid UTF-8, malformed custom addresses, or unsupported address types.

pub fn network(&self) -> &str

Network name associated with this address.

pub const fn port(&self) -> u16

Destination port, or zero for custom-network addresses.

Trait Implementations

impl Clone for SocksAddress

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 SocksAddress

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

Formats the value using the given formatter.

impl Display for SocksAddress

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

Formats the value using the given formatter.

impl Eq for SocksAddress

impl From<SocketAddr> for SocksAddress

fn from(address: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for SocksAddress

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for SocksAddress

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 SocksAddress

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SocksAddress