Enum ProxyStep 

#[non_exhaustive]
pub enum ProxyStep {
    Direct,
    Http(ProxyEndpoint),
    Https(ProxyEndpoint),
    Socks4(ProxyEndpoint),
    Socks5(ProxyEndpoint),
}

Available on crate feature resolve only.

Routing decisions, behind the resolve feature (on by default). Routing decisions, behind the resolve feature (on by default). Routing decisions, behind the resolve feature (on by default). One way to reach a destination (resolve).

Names the protocol to the proxy; bare host:port → ProxyStep::Http. Socks4a/Socks5h collapse to Socks4/Socks5; to_url keeps socks4a/socks5h, scheme does not.

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.

Direct

Connect directly.

Http(ProxyEndpoint)

Plain HTTP proxy (absolute-form requests, CONNECT for TLS).

Https(ProxyEndpoint)

HTTP proxy over TLS.

Socks4(ProxyEndpoint)

SOCKS4 proxy.

Socks5(ProxyEndpoint)

SOCKS5 proxy.

Implementations

impl ProxyStep

pub fn is_direct(&self) -> bool

Whether the step means “no proxy”.

pub fn endpoint(&self) -> Option<&ProxyEndpoint>

The proxy endpoint, or None for ProxyStep::Direct.

pub fn scheme(&self) -> Option<&'static str>

"http" / "https" / "socks4" / "socks5", or None for Direct. Never socks4a/socks5h: use to_url / endpoint().scheme_hint.

pub fn to_url(&self) -> Option<Url>

Proxy URL for HTTP clients, or None for Direct.

None also when the endpoint’s host cannot be written into a URL. Host::Domain wraps a String without validating it and Host is re-exported from the crate root, so a hand-built endpoint can hold characters no URL host may carry; one from ProxyEndpoint::parse cannot. Do not read None as “connect directly”: endpoint is what answers that question.

Percent-encodes credentials (do not log), a % among them. An empty user name with an empty password writes no userinfo, and an empty password beside a user name writes no :; ProxyAuth::password_state still tells the two apart. Keeps socks4a/socks5h from ProxyEndpoint::scheme_hint, unlike scheme. HTTP 407: client job.

let e = ProxyEndpoint::parse("socks5h://proxy.example:1080", 80).unwrap();
assert_eq!(ProxyStep::Socks5(e).to_url().unwrap().scheme(), "socks5h");
assert!(ProxyStep::Direct.to_url().is_none());

Trait Implementations

impl Clone for ProxyStep

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 ProxyStep

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

Formats the value using the given formatter.

impl Eq for ProxyStep

impl Hash for ProxyStep

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 ProxyStep

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProxyStep