[go: up one dir, main page]

ureq::config

Struct Config

source
pub struct Config { /* private fields */ }
Expand description

Config primarily for the Agent, but also per-request.

Config objects are cheap to clone and should not incur any heap allocations.

§Agent level config

§Example

use ureq::Agent;
use std::time::Duration;

let config = Agent::config_builder()
    .timeout_global(Some(Duration::from_secs(10)))
    .https_only(true)
    .build();

let agent = Agent::new_with_config(config);

§Request level config

The config can also be change per-request. Since every request ultimately executes using an Agent (also the root-level ureq::get(...) have an implicit agent), a request level config clones the agent level config.

There are two ways of getting a request level config.

§Request builder example

The first way is via RequestBuilder::config().

use ureq::Agent;

let agent: Agent = Agent::config_builder()
    .https_only(false)
    .build()
    .into();

let response = agent.get("http://httpbin.org/get")
    .config()
    // override agent level setting for this request
    .https_only(true)
    .build()
    .call();

§HTTP request example

The second way is via Agent::configure_request(). This is used when working with the http crate http::Request type directly.

use ureq::Agent;

let agent: Agent = Agent::config_builder()
    .https_only(false)
    .build()
    .into();

let request = http::Request::get("http://httpbin.org/get")
    .body(()).unwrap();

let request = agent.configure_request(request)
    // override agent level setting for this request
    .https_only(true)
    .build();

let response = agent.run(request);

Implementations§

source§

impl Config

source

pub fn builder() -> ConfigBuilder<AgentScope>

A builder to make a bespoke configuration.

The default values are already set.

source

pub fn new_agent(&self) -> Agent

Creates a new agent by cloning this config.

Cloning the config does not incur heap allocations.

Trait Implementations§

source§

impl Clone for Config

source§

fn clone(&self) -> Config

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Config

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Config

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<Config> for Agent

source§

fn from(value: Config) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Config

§

impl !RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl !UnwindSafe for Config

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.