Struct SystemProxyConfig 

pub struct SystemProxyConfig { /* private fields */ }

Available on crate feature std only.

A snapshot of the operating system’s proxy configuration.

HTTP and HTTPS identify the destination scheme, not necessarily the transport protocol used to reach the proxy. A SOCKS5 proxy is used as a fallback when no scheme-specific proxy is configured. A PAC URI takes precedence over fixed proxies because it can make a per-request decision; each platform reader records whether its bypass entries apply before PAC. System proxy routing always bypasses loopback hosts, including before PAC evaluation, matching native proxy stacks.

Implementations

impl SystemProxyConfig

pub async fn try_from_system() -> Result<Self, BoxError>

Read the current platform proxy snapshot.

• Windows uses the active user’s WinINET/Internet Options settings;
• macOS and iOS use CFNetwork’s system proxy dictionary;
• Android uses ConnectivityManager.getDefaultProxy(), with the legacy Proxy API on Android versions before API 23;
• Linux and BSD prefer KDE’s kioslaverc on KDE desktops, otherwise reading GNOME gsettings before falling back to KDE.

This deliberately does not inspect http_proxy or related environment variables. Those are application configuration and are handled by ProxyEnvLayer and NoProxyEnvLayer instead.

Automatic discovery such as WPAD is recorded by Self::auto_detect but is not attempted when the platform does not provide a concrete PAC URI. Malformed non-empty proxy values are reported as errors rather than silently bypassing a configured system policy.

Platform operations that have asynchronous APIs are awaited directly. Native platforms that only expose a synchronous snapshot call keep that call narrowly isolated inside their platform reader.

pub async fn try_from_system_with_invalid_bypass_rule_policy( policy: SystemProxyInvalidBypassRulePolicy, ) -> Result<Self, BoxError>

Read the current platform proxy snapshot with an explicit invalid bypass-rule policy.

Ignore is the default used by Self::try_from_system. Selecting Reject returns an error instead of accepting a snapshot with one or more discarded rules.

pub fn is_empty(&self) -> bool

Return whether this snapshot contains no automatic, PAC, or fixed proxy settings.

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

The proxy for HTTP destinations.

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

The proxy for HTTPS destinations.

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

The SOCKS5 fallback proxy.

pub const fn pac_uri(&self) -> Option<&Uri>

The configured PAC script URI.

pub const fn auto_detect(&self) -> bool

Whether the platform requested automatic proxy discovery (for example, WPAD) without necessarily supplying a concrete PAC URI.

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

Host patterns that bypass fixed proxies.

pub const fn exclude_simple_hostnames(&self) -> bool

Whether names without a dot bypass fixed proxies.

pub const fn reversed_bypass(&self) -> bool

Whether fixed proxies are used only for hosts matching bypass.

KDE exposes this uncommon inverted exception-list mode. The default is false, where matching hosts bypass the proxy in the usual way.

pub fn maybe_with_http_proxy(self, proxy: Option<ProxyAddress>) -> Self

Set the proxy used for HTTP destinations.

pub fn maybe_set_http_proxy(&mut self, proxy: Option<ProxyAddress>) -> &mut Self

Set the proxy used for HTTP destinations.

pub fn with_http_proxy(self, proxy: ProxyAddress) -> Self

Set the proxy used for HTTP destinations.

pub fn set_http_proxy(&mut self, proxy: ProxyAddress) -> &mut Self

Set the proxy used for HTTP destinations.

pub fn without_http_proxy(self) -> Self

Set the proxy used for HTTP destinations.

pub fn unset_http_proxy(&mut self) -> &mut Self

Set the proxy used for HTTP destinations.

pub fn maybe_with_https_proxy(self, proxy: Option<ProxyAddress>) -> Self

Set the proxy used for HTTPS destinations.

pub fn maybe_set_https_proxy( &mut self, proxy: Option<ProxyAddress>, ) -> &mut Self

Set the proxy used for HTTPS destinations.

pub fn with_https_proxy(self, proxy: ProxyAddress) -> Self

Set the proxy used for HTTPS destinations.

pub fn set_https_proxy(&mut self, proxy: ProxyAddress) -> &mut Self

Set the proxy used for HTTPS destinations.

pub fn without_https_proxy(self) -> Self

Set the proxy used for HTTPS destinations.

pub fn unset_https_proxy(&mut self) -> &mut Self

Set the proxy used for HTTPS destinations.

pub fn maybe_with_socks5_proxy(self, proxy: Option<ProxyAddress>) -> Self

Set the SOCKS5 fallback proxy.

pub fn maybe_set_socks5_proxy( &mut self, proxy: Option<ProxyAddress>, ) -> &mut Self

Set the SOCKS5 fallback proxy.

pub fn with_socks5_proxy(self, proxy: ProxyAddress) -> Self

Set the SOCKS5 fallback proxy.

pub fn set_socks5_proxy(&mut self, proxy: ProxyAddress) -> &mut Self

Set the SOCKS5 fallback proxy.

pub fn without_socks5_proxy(self) -> Self

Set the SOCKS5 fallback proxy.

pub fn unset_socks5_proxy(&mut self) -> &mut Self

Set the SOCKS5 fallback proxy.

pub fn maybe_with_pac_uri(self, pac_uri: Option<Uri>) -> Self

Set the PAC script URI.

pub fn maybe_set_pac_uri(&mut self, pac_uri: Option<Uri>) -> &mut Self

Set the PAC script URI.

pub fn with_pac_uri(self, pac_uri: Uri) -> Self

Set the PAC script URI.

pub fn set_pac_uri(&mut self, pac_uri: Uri) -> &mut Self

Set the PAC script URI.

pub fn without_pac_uri(self) -> Self

Set the PAC script URI.

pub fn unset_pac_uri(&mut self) -> &mut Self

Set the PAC script URI.

pub fn with_auto_detect(self, auto_detect: bool) -> Self

Record whether automatic proxy discovery is enabled.

Rama exposes this signal but does not perform WPAD itself.

pub fn set_auto_detect(&mut self, auto_detect: bool) -> &mut Self

Record whether automatic proxy discovery is enabled.

Rama exposes this signal but does not perform WPAD itself.

pub fn with_bypass( self, bypass: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> Self

Replace the fixed-proxy bypass patterns, ignoring invalid entries.

Use Self::try_set_bypass with Reject when an invalid entry should reject the complete update. Boxed strings transfer directly into snapshot storage; borrowed strings are copied because the snapshot owns its rules.

pub fn set_bypass( &mut self, bypass: impl IntoIterator<Item = impl Into<Box<str>>>, ) -> &mut Self

Replace the fixed-proxy bypass patterns, ignoring invalid entries.

Use Self::try_set_bypass with Reject when an invalid entry should reject the complete update. Boxed strings transfer directly into snapshot storage; borrowed strings are copied because the snapshot owns its rules.

pub fn try_with_bypass( self, bypass: impl IntoIterator<Item = impl Into<Box<str>>>, policy: SystemProxyInvalidBypassRulePolicy, ) -> Result<Self, BoxError>

Replace the fixed-proxy bypass patterns using an explicit invalid-rule policy.

The update is atomic: when Reject encounters an invalid rule, this returns an error and leaves the prior bypass list unchanged. Boxed strings transfer directly into snapshot storage; borrowed strings are copied because the snapshot owns its rules.

pub fn try_set_bypass( &mut self, bypass: impl IntoIterator<Item = impl Into<Box<str>>>, policy: SystemProxyInvalidBypassRulePolicy, ) -> Result<&mut Self, BoxError>

Replace the fixed-proxy bypass patterns using an explicit invalid-rule policy.

The update is atomic: when Reject encounters an invalid rule, this returns an error and leaves the prior bypass list unchanged. Boxed strings transfer directly into snapshot storage; borrowed strings are copied because the snapshot owns its rules.

pub fn with_exclude_simple_hostnames(self, exclude: bool) -> Self

Configure whether names without a dot bypass fixed proxies.

pub fn set_exclude_simple_hostnames(&mut self, exclude: bool) -> &mut Self

Configure whether names without a dot bypass fixed proxies.

pub fn with_reversed_bypass(self, reversed: bool) -> Self

Invert the meaning of fixed-proxy bypass patterns.

pub fn set_reversed_bypass(&mut self, reversed: bool) -> &mut Self

Invert the meaning of fixed-proxy bypass patterns.

Trait Implementations

impl Clone for SystemProxyConfig

fn clone(&self) -> SystemProxyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemProxyConfig

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

Formats the value using the given formatter.

impl Default for SystemProxyConfig

fn default() -> SystemProxyConfig

Returns the “default value” for a type.