Struct ProxyConfig 

pub struct ProxyConfig {
    pub mode: ProxyMode,
    pub protocol: Option<String>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub bypass: Vec<String>,
    pub pac_url: Option<String>,
    pub pac_script: Option<String>,
}

Proxy configuration.

Here rather than in tropel-http, where the bypass matching and PAC failover live, for the same reason AuthConfig is here while the signers are in tropel-auth: this is the DATA a request carries, and Request is in this crate. A type in tropel-http could not be a field of Request at all — the SDK is a leaf and depends on zero tropel-* crates.

One struct for all four modes rather than an enum with per-mode payloads: it crosses a JSON wire (KnockPort’s settings.proxy) where an externally-tagged enum would change shape per mode, and a UI that lets the user switch mode must not lose the host they typed for fixed when they look at system.

Hash because it KEYS a client map: reqwest bakes proxies in at build time, so one lazily-built client per distinct profile is how a per-request proxy is executed at all.

Fields

mode: ProxyMode

protocol: Option<String>

http, https, socks5 — the proxy’s own scheme, not the target’s.

host: Option<String>

port: Option<u16>

username: Option<String>

password: Option<String>

bypass: Vec<String>

Hosts that must NOT go through the proxy.

pac_url: Option<String>

pac mode: where to fetch the script, or the script itself.

pac_script: Option<String>

Implementations

impl ProxyConfig

pub fn fixed_url(&self) -> Option<String>

The proxy URL for fixed mode, WITHOUT credentials.

Credentials go through Proxy::basic_auth, never the URL: a proxy URL with a password in it is logged by everything that logs a URL, and reqwest would also have to re-encode it.

pub fn is_off(&self) -> bool

Whether this config asks for a proxy at all.

Off is not the same as absent, and both must behave the same way at the client: a request that explicitly says “no proxy” must not inherit the client’s.

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<(), Error>

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

where ProxyConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProxyConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProxyConfig

impl Hash for ProxyConfig

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 ProxyConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProxyConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProxyConfig