[][src]Struct reqwest::Proxy

pub struct Proxy { /* fields omitted */ }

Configuration of a proxy that a Client should pass requests to.

A Proxy has a couple pieces to it:

For instance, let's look at Proxy::http:

let proxy = reqwest::Proxy::http("https://secure.example")?;

This proxy will intercept all HTTP requests, and make use of the proxy at https://secure.example. A request to http://hyper.rs will talk to your proxy. A request to https://hyper.rs will not.

Multiple Proxy rules can be configured for a Client. The Client will check each Proxy in the order it was added. This could mean that a Proxy added first with eager intercept rules, such as Proxy::all, would prevent a Proxy later in the list from ever working, so take care.

Methods

impl Proxy[src]

pub fn http<U: IntoProxyScheme>(proxy_scheme: U) -> Result<Proxy>[src]

Proxy all HTTP traffic to the passed URL.

Example

let client = reqwest::Client::builder()
    .proxy(reqwest::Proxy::http("https://my.prox")?)
    .build()?;

pub fn https<U: IntoProxyScheme>(proxy_scheme: U) -> Result<Proxy>[src]

Proxy all HTTPS traffic to the passed URL.

Example

let client = reqwest::Client::builder()
    .proxy(reqwest::Proxy::https("https://example.prox:4545")?)
    .build()?;

pub fn all<U: IntoProxyScheme>(proxy_scheme: U) -> Result<Proxy>[src]

Proxy all traffic to the passed URL.

Example

let client = reqwest::Client::builder()
    .proxy(reqwest::Proxy::all("http://pro.xy")?)
    .build()?;

pub fn custom<F, U: IntoProxyScheme>(fun: F) -> Proxy where
    F: Fn(&Url) -> Option<U> + Send + Sync + 'static, 
[src]

Provide a custom function to determine what traffix to proxy to where.

Example

let target = reqwest::Url::parse("https://my.prox")?;
let client = reqwest::Client::builder()
    .proxy(reqwest::Proxy::custom(move |url| {
        if url.host_str() == Some("hyper.rs") {
            Some(target.clone())
        } else {
            None
        }
    }))
    .build()?;

pub fn basic_auth(self, username: &str, password: &str) -> Proxy[src]

Set the Proxy-Authorization header using Basic auth.

Example

let proxy = reqwest::Proxy::https("http://localhost:1234")?
    .basic_auth("Aladdin", "open sesame");

Trait Implementations

impl Clone for Proxy[src]

impl Debug for Proxy[src]

Auto Trait Implementations

impl Send for Proxy

impl Unpin for Proxy

impl Sync for Proxy

impl !UnwindSafe for Proxy

impl !RefUnwindSafe for Proxy

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Err = <U as TryFrom<T>>::Err