Struct ProxyEnvLayer 

pub struct ProxyEnvLayer { /* private fields */ }

Available on crate feature net only.

Lazily select a proxy from curl-compatible environment variables.

HTTP requests use lowercase http_proxy; uppercase HTTP_PROXY is never read because CGI turns an incoming Proxy header into that variable. Every request first tries its URL scheme’s lowercase and uppercase proxy variables, then all_proxy and ALL_PROXY. HTTP is the security-sensitive exception: only lowercase http_proxy is accepted. For example, WebSocket requests use ws_proxy / WS_PROXY, not http_proxy.

Every variable group has an independent, shared cache. A request only reads the group it needs, and ALL_PROXY is not read when a scheme-specific proxy exists. Empty name lists disable the corresponding group.

See curl’s proxy environment variable documentation for the interoperability rules this layer follows.

Implementations

impl ProxyEnvLayer

pub fn new() -> ProxyEnvLayer

Create a lazy layer backed by the process environment.

pub fn new_with_reader<F>(reader: F) -> ProxyEnvLayer

where F: Fn(&str) -> Result<Option<String>, Box<dyn Error + Sync + Send>> + Send + Sync + 'static,

Create a lazy layer backed by a custom environment reader.

This is useful for applications which virtualize their environment and for deterministic tests. Ok(None) means that the name is not defined. The reader runs synchronously during the first request for a variable group and should therefore avoid blocking I/O; concurrent callers await the same cached initialization.

pub fn with_http_proxy_env_vars( self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> ProxyEnvLayer

Replace the ordered HTTP proxy environment-variable names.

The default is only http_proxy. Supplying no names disables this scheme-specific lookup.

pub fn set_http_proxy_env_vars( &mut self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> &mut ProxyEnvLayer

Replace the ordered HTTP proxy environment-variable names.

The default is only http_proxy. Supplying no names disables this scheme-specific lookup.

pub fn with_https_proxy_env_vars( self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> ProxyEnvLayer

Replace the ordered HTTPS proxy environment-variable names.

The default is https_proxy, then HTTPS_PROXY. Supplying no names disables this scheme-specific lookup.

pub fn set_https_proxy_env_vars( &mut self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> &mut ProxyEnvLayer

Replace the ordered HTTPS proxy environment-variable names.

The default is https_proxy, then HTTPS_PROXY. Supplying no names disables this scheme-specific lookup.

pub fn with_protocol_proxy_env_vars( self, protocol: Protocol, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> ProxyEnvLayer

Replace the ordered proxy environment-variable names for one URL protocol. Supplying no names disables its scheme-specific lookup.

pub fn set_protocol_proxy_env_vars( &mut self, protocol: Protocol, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> &mut ProxyEnvLayer

Replace the ordered proxy environment-variable names for one URL protocol. Supplying no names disables its scheme-specific lookup.

pub fn with_all_proxy_env_vars( self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> ProxyEnvLayer

Replace the ordered all-protocol proxy environment-variable names.

The default is all_proxy, then ALL_PROXY. Supplying no names disables the fallback entirely.

pub fn set_all_proxy_env_vars( &mut self, names: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> &mut ProxyEnvLayer

Replace the ordered all-protocol proxy environment-variable names.

The default is all_proxy, then ALL_PROXY. Supplying no names disables the fallback entirely.

pub fn with_load_error_sink(self, sink: impl ErrorSink) -> ProxyEnvLayer

Handle each lazy load error through an ErrorSink and treat that variable group as absent. By default errors reject the request.

The handled result is cached, so a sink is called at most once for each variable group.

pub fn set_load_error_sink( &mut self, sink: impl ErrorSink, ) -> &mut ProxyEnvLayer

Handle each lazy load error through an ErrorSink and treat that variable group as absent. By default errors reject the request.

The handled result is cached, so a sink is called at most once for each variable group.

pub fn with_overwrite(self, overwrite: bool) -> ProxyEnvLayer

Replace an existing ProxyRoute or ProxyRoutes decision.

pub fn set_overwrite(&mut self, overwrite: bool) -> &mut ProxyEnvLayer

Replace an existing ProxyRoute or ProxyRoutes decision.

Trait Implementations

impl Clone for ProxyEnvLayer

fn clone(&self) -> ProxyEnvLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyEnvLayer

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

Formats the value using the given formatter.

impl Default for ProxyEnvLayer

fn default() -> ProxyEnvLayer

Returns the “default value” for a type.

impl<S> Layer<S> for ProxyEnvLayer

type Service = ProxyEnvService<S>

The service produced by the layer.

fn layer(&self, inner: S) -> <ProxyEnvLayer as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> <ProxyEnvLayer as Layer<S>>::Service

Same as layer but consuming self after the service was created.