Enum ProxyProtocol 

#[non_exhaustive]
pub enum ProxyProtocol {
    Socks {
        version: SocksVersion,
        auth: SocksAuth,
        addr: SocketAddr,
    },
    HttpConnect {
        addr: SocketAddr,
        credentials: Option<HttpConnectAuth>,
    },
}

Information about what proxy protocol to use, and how to use it.

This type can be parsed from a URI string using the same format as curl’s proxy URL syntax (see https://curl.se/docs/url-syntax.html).

Supported formats:

• socks4://ip:port - SOCKS4 proxy

• socks4://user@ip:port - SOCKS4 proxy with user ID

• socks4a://ip:port - SOCKS4a proxy (treated same as socks4)

• socks5://ip:port - SOCKS5 proxy without auth

• socks5://user:pass@ip:port - SOCKS5 proxy with username/password auth

• socks5://user@ip:port - SOCKS5 proxy with username only (empty password)

• socks5h://ip:port - SOCKS5 with remote hostname resolution (treated same as socks5)

• Hostnames for the proxy server itself are not supported (applies to all proxy types).

• Credentials must be embedded in the URI; curl’s -U user:pass style is not supported.

• For socks4://, passwords are not supported and will return an error.

• Special characters in credentials are percent-encoded using the url crate’s userinfo encoding.

HTTP CONNECT:

Hostnames for the proxy server itself are not supported (only IP addresses).

• http://ip:port - HTTP CONNECT proxy without auth
• http://user:pass@ip:port - HTTP CONNECT proxy with Basic auth (RFC 7617)
• http://user@ip:port - HTTP CONNECT proxy with username only (empty password)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Socks

Connect via SOCKS 4, SOCKS 4a, or SOCKS 5.

Fields

version: SocksVersion

The SOCKS version to use

auth: SocksAuth

The authentication method to use

addr: SocketAddr

The proxy server address

HttpConnect

Connect via HTTP CONNECT proxy.

Fields

addr: SocketAddr

The proxy server address

credentials: Option<HttpConnectAuth>

Optional credentials for Basic auth (RFC 7617)

Implementations

impl ProxyProtocol

pub fn is_loopback(&self) -> bool

Check whether the proxy server address is on the loopback interface.

impl ProxyProtocol

pub fn socks_no_auth(version: SocksVersion, addr: SocketAddr) -> Self

Create a new SOCKS proxy configuration with no authentication

Trait Implementations

impl Clone for ProxyProtocol

fn clone(&self) -> ProxyProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyProtocol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProxyProtocol

where Self: FromStr, <Self as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProxyProtocol

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

Formats the value using the given formatter.

impl FromStr for ProxyProtocol

type Err = ProxyProtocolParseError

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

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

where Self: Display,

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 ProxyProtocol

impl StructuralPartialEq for ProxyProtocol