Struct ProxyConfig 

pub struct ProxyConfig { /* private fields */ }

Proxy configuration supporting HTTP, HTTPS, and SOCKS5 proxies.

Examples

use yt_dlp::client::proxy::{ProxyConfig, ProxyType};

// Simple HTTP proxy
let proxy = ProxyConfig::new(ProxyType::Http, "http://proxy.example.com:8080");

// SOCKS5 proxy with authentication
let proxy = ProxyConfig::new(ProxyType::Socks5, "socks5://proxy.example.com:1080")
    .with_auth("username", "password");

// With no-proxy list
let proxy = ProxyConfig::new(ProxyType::Http, "http://proxy.example.com:8080")
    .with_no_proxy(vec!["localhost".to_string(), "127.0.0.1".to_string()]);

Implementations

impl ProxyConfig

pub fn new(proxy_type: ProxyType, url: impl Into<String>) -> Self

Creates a new proxy configuration.

Arguments

• proxy_type - The type of proxy (HTTP, HTTPS, or SOCKS5)
• url - The proxy URL (e.g., “http://proxy.example.com:8080”)

Returns

A new ProxyConfig instance

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

Adds authentication credentials to the proxy.

Arguments

• username - The proxy username
• password - The proxy password

Returns

Self for method chaining

pub fn with_no_proxy(self, no_proxy: Vec<String>) -> Self

Sets the list of domains that should bypass the proxy.

Arguments

• no_proxy - List of domains to bypass (e.g., [“localhost”, “127.0.0.1”])

Returns

Self for method chaining

pub fn proxy_type(&self) -> &ProxyType

Returns the proxy type.

Returns

A reference to the configured ProxyType.

pub fn url(&self) -> &str

Returns the proxy URL.

Returns

The proxy URL as a string slice.

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

Returns the username if authentication is configured.

Returns

The proxy username, or None if no authentication is set.

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

Returns the password if authentication is configured.

Returns

The proxy password, or None if no authentication is set.

pub fn no_proxy(&self) -> &[String]

Returns the no-proxy list.

Returns

A slice of domain strings that should bypass the proxy.

pub fn build_url(&self) -> String

Builds the complete proxy URL with authentication if configured.

Returns

The proxy URL with embedded authentication credentials if provided

pub fn to_reqwest_proxy(&self) -> Result<Proxy>

Converts to reqwest proxy format.

Returns

Result containing the reqwest Proxy instance

Errors

Returns error if the proxy URL is invalid

pub fn to_ytdlp_arg(&self) -> String

Converts to yt-dlp proxy argument format.

Returns

The proxy URL in the format expected by yt-dlp’s --proxy argument. Includes authentication credentials if configured.

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

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

Formats the value using the given formatter.

impl Display for ProxyConfig

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

Formats the value using the given formatter.