Struct ProxyRule 

pub struct ProxyRule {
    pub scope: ProxyScope,
    pub url: String,
    pub auth: Option<ProxyAuth>,
    pub no_proxy: Option<String>,
}

One proxy: where it lives, which requests go through it, and which hosts bypass it.

Fields

scope: ProxyScope

Which request URLs this rule applies to.

url: String

The proxy’s own URL, e.g. http://proxy.corp:8080. http and https proxies are always supported; socks4, socks5, and socks5h need the crate’s socks feature. An unparseable or unsupported URL is reported by Fetcher::new.

auth: Option<ProxyAuth>

Credentials for the proxy, if it demands any.

no_proxy: Option<String>

Hosts that bypass this proxy, in NO_PROXY syntax: comma-separated entries, each a domain (matching that domain and its subdomains), an IP address, a CIDR block, or * for everything. None sends every in-scope request through the proxy — note that this does not fall back to the NO_PROXY environment variable, since configuring a rule programmatically opts out of the environment entirely.

Implementations

impl ProxyRule

pub fn all(url: impl Into<String>) -> Self

A rule routing every request through url, whatever the scheme.

pub fn http(url: impl Into<String>) -> Self

A rule routing http:// requests through url.

pub fn https(url: impl Into<String>) -> Self

A rule routing https:// requests through url.

pub fn new(scope: ProxyScope, url: impl Into<String>) -> Self

A rule with an explicit scope, no credentials, and no bypass list.

pub fn with_basic_auth( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Present username / password to the proxy via Proxy-Authorization: Basic.

pub fn with_custom_auth(self, header_value: impl Into<String>) -> Self

Present a verbatim Proxy-Authorization header value, e.g. "Bearer <token>".

pub fn bypassing(self, no_proxy: impl Into<String>) -> Self

Exempt hosts from this proxy, in NO_PROXY syntax — see ProxyRule::no_proxy.

Trait Implementations

impl Clone for ProxyRule

fn clone(&self) -> ProxyRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyRule

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

Formats the value using the given formatter.

impl Eq for ProxyRule

impl PartialEq for ProxyRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProxyRule