Enum ProxyConfig 

pub enum ProxyConfig {
    None,
    Global {
        url: Url,
    },
    ByDomain(Vec<PartialProxyConfig>),
}

Examples:

• No proxy (default):

proxy ="none"

• Global proxy

[global.proxy]
global = { url = "socks5h://localhost:9050" }

• Proxy some domains

[global.proxy]
[[global.proxy.by_domain]]
url = "socks5h://localhost:9050"
include = ["*.onion", "matrix.myspecial.onion"]
exclude = ["*.myspecial.onion"]

Include vs. Exclude

If include is an empty list, it is assumed to be ["*"].

If a domain matches both the exclude and include list, the proxy will only be used if it was included because of a more specific rule than it was excluded. In the above example, the proxy would be used for ordinary.onion, matrix.myspecial.onion, but not hello.myspecial.onion.

Variants

None

Adds no application-configured proxy.

The HTTP client builder remains unchanged, so automatic system proxy discovery may still apply. This is the default configuration.

Global

Routes every eligible request through one proxy.

The same proxy URL applies regardless of the request destination. The URL is parsed while the configuration is loaded.

Fields

url: Url

Identifies the proxy endpoint.

The URL may select any proxy scheme supported by the HTTP client. It is converted into a request proxy during client construction.

ByDomain(Vec<PartialProxyConfig>)

Selects proxies using ordered domain rules.

Each rule may include or exclude wildcarded domains. The first rule that accepts a request supplies its proxy URL.

Implementations

impl ProxyConfig

pub fn to_proxy(&self) -> Result<Option<Proxy>>

Builds the HTTP client’s proxy configuration.

The default configuration returns no application proxy. Global and domain-based configuration produce the corresponding reqwest proxy selector.

impl ProxyConfig

fn validate_proxy_schemes(&self) -> Result

impl ProxyConfig

pub fn hosts(&self) -> impl Iterator<Item = &str>

Iterates over application-configured proxy endpoint names.

The iterator borrows the configured URLs and allocates no intermediate collection. Automatic environment proxies are captured by ProxySnapshot.

impl ProxyConfig

fn proxy_urls(&self) -> impl Iterator<Item = &Url>

impl ProxyConfig

pub fn intercepts(&self, url: &Url) -> bool

Reports whether an application-configured proxy carries a request URL.

Domain rules reuse the same include and exclude predicate as the reqwest proxy selector.

impl ProxyConfig

fn proxy_for(&self, url: &Url) -> Option<&Url>

impl ProxyConfig

fn to_proxy_shared(config: &Arc<Self>) -> Result<Option<Proxy>>

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyConfig

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

Formats the value using the given formatter.

impl Default for ProxyConfig

fn default() -> ProxyConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProxyConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.