Struct ProxyConfig 

pub struct ProxyConfig { /* private fields */ }

Explicit proxy used by panel HTTP, WebSocket, and subscription requests.

Proxy URLs must not contain credentials. Add username/password separately with ProxyConfig::with_basic_auth so ordinary URL and Debug handling cannot expose them.

Implementations

impl ProxyConfig

pub fn new(url: impl AsRef<str>) -> Result<Self>

Parses an HTTP, HTTPS, SOCKS5, or SOCKS5h proxy URL.

Errors

Returns Error::Configuration for an unsupported/relative URL, embedded credentials, or a path, query, or fragment.

pub fn with_basic_auth( self, username: impl Into<String>, password: impl Into<String>, ) -> Result<Self>

Adds HTTP Basic or SOCKS5 username/password authentication.

Errors

Returns Error::Configuration when the username is empty/contains a colon or SOCKS5’s one-byte username/password length limit is exceeded.

pub const fn scheme(&self) -> ProxyScheme

Returns the selected proxy protocol and DNS behavior.

pub const fn url(&self) -> &Url

Returns the credential-free proxy endpoint URL.

pub const fn has_basic_auth(&self) -> bool

Returns whether proxy authentication is configured.

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> Self

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for ProxyConfig

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl TryFrom<&str> for ProxyConfig

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for ProxyConfig

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.