Enum ProxyScheme 

#[non_exhaustive]
pub enum ProxyScheme {
    Http,
    Https,
    Socks4,
    Socks4a,
    Socks5,
    Socks5h,
}

The wire protocol used to reach the proxy itself.

Only ever a hint: most operating system sources (the Windows registry in particular) store a bare host:port and leave the protocol implicit.

Where a source names SOCKS without a version (GNOME’s socks child, KDE’s socksProxy and macOS’s SOCKSProxy) this crate reports ProxyScheme::Socks5. That is a compatibility choice and not something read out of the setting: Chromium makes the same one and calls it a “policy decision” where it makes it, in proxy_config_service_linux.cc. GIO chose otherwise, treating such a setting as standing for SOCKS5, SOCKS4a and SOCKS4 alike, so a proxy that speaks only SOCKS4 is reachable from a GIO application and not from a caller that takes this hint literally.

A version written into the value is kept: socks4://proxy.example.com in GNOME’s host child or KDE’s socksProxy reads as Socks4, because the readers apply their default only when the value specifies no version. Chromium reads it the same way: “we default to socks 5, but if the user specifically set it to socks4://, then use that”, in FixupProxyHostScheme. The native stacks do not: glib-networking formats socks://%s:%u from the host key verbatim, and KF5-era KIO replaces whatever scheme it finds with a bare socks://. This spelling is an escape hatch from this crate’s default; the platform’s own resolver still sees SOCKS5 or an invalid value.

The same word can mean different versions in different sources: a socks:// URI is SOCKS5, while the Windows registry’s socks=host:port is read as SOCKS4. Microsoft gives that token no version of its own, but WinINet owns the key, and the feature table in WinINet vs. WinHTTP grants it SOCKS4 alone: “SOCKS4 (SOCKS version 4) support. Doesn’t include v4a” is yes for WinINet, and “SOCKS5 (SOCKS version 5) support” is no.

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.

Http

Plain HTTP proxy (CONNECT for TLS). Default port 80.

Https

TLS-wrapped HTTP proxy. Default port 443.

Socks4

SOCKS4, names resolved locally. Default port 1080.

Socks4a

SOCKS4a, names resolved by the proxy. Default port 1080.

Socks5

SOCKS5, names resolved locally. Default port 1080.

Socks5h

SOCKS5, names resolved by the proxy. Default port 1080.

Implementations

impl ProxyScheme

pub fn as_str(self) -> &'static str

The canonical lowercase URL scheme.

pub fn default_port(self) -> u16

The port assumed when the source omitted one.

Trait Implementations

impl Clone for ProxyScheme

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProxyScheme

impl Debug for ProxyScheme

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

Formats the value using the given formatter.

impl Display for ProxyScheme

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

Formats the value using the given formatter.

impl Eq for ProxyScheme

impl FromStr for ProxyScheme

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 ProxyScheme

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 ProxyScheme

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 ProxyScheme

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ProxyScheme

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 StructuralPartialEq for ProxyScheme