Skip to main content

ProxyConfig

Struct ProxyConfig 

Source
pub struct ProxyConfig { /* private fields */ }
Expand description

Explicit proxy routing. Defaults to direct connections and never reads proxy environment variables.

Implementations§

Source§

impl ProxyConfig

Source

pub fn direct() -> Self

Selects direct connections without consulting proxy environment variables.

Source

pub fn http_connect( url: &str, auth: Option<ProxyBasicAuth>, ) -> Result<Self, NetError>

Routes ws and wss targets through an HTTP CONNECT tunnel.

Accepts only http://host[:port]; credentials must be supplied separately. Authentication is rejected before any network activity. Use Self::https_connect to protect credentials, or explicitly opt in with Self::http_connect_with_auth_policy and ProxyAuthTransportPolicy::AllowPlaintext.

Source

pub fn http_connect_with_auth_policy( url: &str, auth: Option<ProxyBasicAuth>, policy: ProxyAuthTransportPolicy, ) -> Result<Self, NetError>

Routes targets through an HTTP CONNECT tunnel using the explicit authentication transport policy.

AllowPlaintext permits credentials to be sent without encryption, including when the target uses wss. This is an explicit compatibility exception; prefer Self::https_connect.

Source

pub fn https_connect( url: &str, auth: Option<ProxyBasicAuth>, proxy_tls: TlsConfig, ) -> Result<Self, NetError>

Establishes TLS to an HTTPS proxy before sending HTTP/1.1 CONNECT.

Accepts only https://host[:port], with port 443 by default. Proxy certificates are validated against the URL host using proxy_tls. Proxy roots, client identity, and explicit provider are independent of NetworkConfig::with_tls. Failure never falls back to plaintext. For ws targets, only the client-to-proxy connection is encrypted.

Source

pub fn is_direct(&self) -> bool

Returns true when connections bypass a proxy.

Source

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

Returns the credential-free normalized HTTP or HTTPS proxy URL, or None for direct mode.

Source

pub fn is_authenticated(&self) -> bool

Returns whether proxy credentials are configured.

Source

pub fn proxy_tls(&self) -> Option<&TlsConfig>

Returns the independent TLS configuration for an HTTPS proxy. Direct connections and plaintext HTTP proxies return None.

Source

pub fn auth_transport_policy(&self) -> Option<ProxyAuthTransportPolicy>

Returns the configured proxy authentication transport policy, or None for direct connections. HTTPS proxies always require TLS.

Trait Implementations§

Source§

impl Clone for ProxyConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProxyConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProxyConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more