Skip to main content

ProxyOptions

Struct ProxyOptions

pub struct ProxyOptions {
    pub enabled: bool,
    pub proxy_type: ProxyType,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub username: Option<String>,
    pub password: Option<String>,
}

Expand description

Outbound proxy configuration applied when building the reqwest client.

Fields§

§enabled: bool

Whether proxy is enabled.

§proxy_type: ProxyType

Proxy type.

§host: Option<String>

Proxy host.

§port: Option<u16>

Proxy port.

§username: Option<String>

Proxy username.

§password: Option<String>

Proxy password.

Implementations§

impl ProxyOptions

pub fn from_config<R>(config: &R) -> Result<Self, HttpConfigError>
where R: ConfigReader + ?Sized,

Reads proxy settings from config using relative keys.

§Parameters

config: Any ConfigReader (e.g. config.prefix_view("proxy")).

Keys read:

enabled
proxy_type
host
port
username
password

§Returns

Populated ProxyOptions or HttpConfigError.

pub fn validate(&self) -> Result<(), HttpConfigError>

Validates proxy options for internal consistency.

§Returns

Ok(()) when disabled or when enabled with valid host/port and credential pairing.
Err(HttpConfigError) if proxy is enabled but host/port invalid, or password without username.

Trait Implementations§

impl Clone for ProxyOptions

fn clone(&self) -> ProxyOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ProxyOptions

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

Formats the value using the given formatter. Read more

impl Default for ProxyOptions

fn default() -> Self

Proxy disabled; type HTTP; no host, port, or credentials.

§Returns

Default ProxyOptions.

impl PartialEq for ProxyOptions

fn eq(&self, other: &ProxyOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ProxyOptions

impl StructuralPartialEq for ProxyOptions

Auto Trait Implementations§

impl Freeze for ProxyOptions

impl RefUnwindSafe for ProxyOptions

impl Send for ProxyOptions

impl Sync for ProxyOptions

impl Unpin for ProxyOptions

impl UnsafeUnpin for ProxyOptions

impl UnwindSafe for ProxyOptions

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more