Struct ProxyConfig 

pub struct ProxyConfig { /* private fields */ }

Proxy configuration for routing requests through an HTTP proxy.

The proxy URL itself must be http://..., including when tunneling HTTPS via CONNECT.

Implementations

impl ProxyConfig

pub fn new<U: ToUrl>(url: U) -> Result<Self, NanoGetError>

Creates a new proxy configuration.

The URL must use http://; otherwise NanoGetError::UnsupportedProxyScheme is returned.

Examples found in repository

examples/proxy-and-proxy-auth/main.rs (line 29)

fn main() -> Result<(), Box<dyn Error>> {
    let Some(proxy_url) = env::var("NANO_GET_PROXY_URL").ok() else {
        print_setup();
        return Ok(());
    };

    let target_url = env_or_default("NANO_GET_PROXY_TARGET_URL", "http://example.com");
    let proxy_user = env_or_default("NANO_GET_PROXY_AUTH_USER", "proxy-user");
    let proxy_pass = env_or_default("NANO_GET_PROXY_AUTH_PASS", "proxy-pass");

    let mut proxy = ProxyConfig::new(proxy_url)?;
    proxy.add_header("X-Example-Proxy", "nano-get-demo")?;

    let challenge_driven = Client::builder()
        .proxy(proxy.clone())
        .basic_proxy_auth(proxy_user.clone(), proxy_pass.clone())
        .build()
        .execute(Request::get(&target_url)?)?;

    let preemptive = Client::builder()
        .proxy(proxy.clone())
        .preemptive_basic_proxy_auth(proxy_user.clone(), proxy_pass.clone())
        .build()
        .execute(Request::get(&target_url)?)?;

    let mut manual = Request::get(&target_url)?;
    manual.proxy_basic_auth(proxy_user, proxy_pass)?;
    let manual_response = Client::builder().proxy(proxy).build().execute(manual)?;

    println!("proxy-and-proxy-auth example");
    println!("challenge-driven status: {}", challenge_driven.status_code);
    println!("preemptive status: {}", preemptive.status_code);
    println!(
        "request-level override status: {}",
        manual_response.status_code
    );

    Ok(())
}

pub fn url(&self) -> &Url

Returns the parsed proxy URL.

pub fn headers(&self) -> &[Header]

Returns additional headers that will be attached to proxy requests.

pub fn add_header( &mut self, name: impl Into<String>, value: impl Into<String>, ) -> Result<&mut Self, NanoGetError>

Adds a custom header to outgoing proxy requests.

Protocol-managed and hop-by-hop headers are rejected.

Examples found in repository

examples/proxy-and-proxy-auth/main.rs (line 30)

fn main() -> Result<(), Box<dyn Error>> {
    let Some(proxy_url) = env::var("NANO_GET_PROXY_URL").ok() else {
        print_setup();
        return Ok(());
    };

    let target_url = env_or_default("NANO_GET_PROXY_TARGET_URL", "http://example.com");
    let proxy_user = env_or_default("NANO_GET_PROXY_AUTH_USER", "proxy-user");
    let proxy_pass = env_or_default("NANO_GET_PROXY_AUTH_PASS", "proxy-pass");

    let mut proxy = ProxyConfig::new(proxy_url)?;
    proxy.add_header("X-Example-Proxy", "nano-get-demo")?;

    let challenge_driven = Client::builder()
        .proxy(proxy.clone())
        .basic_proxy_auth(proxy_user.clone(), proxy_pass.clone())
        .build()
        .execute(Request::get(&target_url)?)?;

    let preemptive = Client::builder()
        .proxy(proxy.clone())
        .preemptive_basic_proxy_auth(proxy_user.clone(), proxy_pass.clone())
        .build()
        .execute(Request::get(&target_url)?)?;

    let mut manual = Request::get(&target_url)?;
    manual.proxy_basic_auth(proxy_user, proxy_pass)?;
    let manual_response = Client::builder().proxy(proxy).build().execute(manual)?;

    println!("proxy-and-proxy-auth example");
    println!("challenge-driven status: {}", challenge_driven.status_code);
    println!("preemptive status: {}", preemptive.status_code);
    println!(
        "request-level override status: {}",
        manual_response.status_code
    );

    Ok(())
}

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.