Struct ProxyAddressLayer 

pub struct ProxyAddressLayer { /* private fields */ }

Available on crate feature net only.

Apply one fixed proxy address to any service input with extensions.

This layer reads application environment variables only when constructed with try_from_env. It does not inspect operating system proxy settings; use SystemProxyLayer for those. When the layers are chained, existing route decisions are preserved by default. Opt into overwriting only when this address is authoritative. Use LazyProxyAddressLayer when environment lookup should happen only if no higher-priority route has already been selected.

See ProxyAddressService for more information.

Implementations

impl ProxyAddressLayer

pub fn new(address: ProxyAddress) -> ProxyAddressLayer

Create a new ProxyAddressLayer that will create a service to set the given ProxyAddress as a proxied ProxyRoute.

pub fn maybe(address: Option<ProxyAddress>) -> ProxyAddressLayer

Create a new ProxyAddressLayer which will create a service that will set the given ProxyAddress as a proxied ProxyRoute if it is not None.

pub const fn proxy_address(&self) -> Option<&ProxyAddress>

Return the configured proxy address, when this layer has one.

pub fn try_from_env_default() -> Result<ProxyAddressLayer, Box<dyn Error + Sync + Send>>

Try to create a new ProxyAddressLayer which will establish a proxy connection over the environment variable http_proxy.

Uppercase HTTP_PROXY is deliberately not accepted by default because CGI derives it from an incoming Proxy header. Use ProxyEnvLayer for curl-compatible HTTP, HTTPS, and all-protocol environment selection.

pub fn try_from_env( key: impl AsRef<str>, ) -> Result<ProxyAddressLayer, Box<dyn Error + Sync + Send>>

Try to create a new ProxyAddressLayer which will establish a proxy connection over the given environment variable.

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

Replace an existing ProxyRoute or ProxyRoutes decision. Existing routes are preserved by default.

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

Replace an existing ProxyRoute or ProxyRoutes decision. Existing routes are preserved by default.

Trait Implementations

impl Clone for ProxyAddressLayer

fn clone(&self) -> ProxyAddressLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyAddressLayer

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

Formats the value using the given formatter.

impl Default for ProxyAddressLayer

fn default() -> ProxyAddressLayer

Returns the “default value” for a type.

impl<S> Layer<S> for ProxyAddressLayer

type Service = ProxyAddressService<S>

The service produced by the layer.

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

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

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

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