Skip to main content

HttpClient

Struct HttpClient 

Source
pub struct HttpClient { /* private fields */ }
Expand description

HTTP client, see the module documentation. Cloning shares the connection pool.

Implementations§

Source§

impl HttpClient

Source

pub fn new() -> Self

Source

pub fn timeout(self, timeout: Duration) -> Self

Longest a single attempt (connect, send, read the whole response) may take (default 30 s)

Source

pub fn connect_timeout(self, timeout: Duration) -> Self

Longest name resolution + TCP/TLS connect may take (default 10 s)

Source

pub fn max_response_bytes(self, max: usize) -> Self

Largest response body accepted (default 10 MiB)

Source

pub fn max_redirects(self, max: usize) -> Self

Redirects followed per call (default 5, 0 returns the 3xx response itself)

Source

pub fn retries(self, retries: u32) -> Self

Extra attempts after a failure that is safe to repeat (default 0)

Source

pub fn retry_backoff(self, base: Duration) -> Self

First retry delay, doubled each time with jitter (default 200 ms)

Source

pub fn public_only(self) -> Self

Only connect to public addresses: loopback, private, link-local and cloud-metadata targets are refused with ClientError::Blocked. Use it whenever the URL comes from a user (webhooks, link previews, imports).

Source

pub fn user_agent(self, agent: &str) -> Self

Source

pub fn default_header(self, name: &str, value: &str) -> Self

Header sent with every request (unless the request sets it itself)

Source

pub fn pool_idle_timeout(self, timeout: Duration) -> Self

Keep idle connections this long for reuse (default 30 s, zero disables pooling)

Source

pub fn add_root_certificates_pem(self, pem: &[u8]) -> Result<Self, ClientError>

Trust these PEM root certificates in addition to the built-in ones, e.g. a private CA (feature client-tls)

Source

pub fn request(&self, method: Method, url: &str) -> RequestBuilder

Source

pub fn get(&self, url: &str) -> RequestBuilder

Source

pub fn post(&self, url: &str) -> RequestBuilder

Source

pub fn put(&self, url: &str) -> RequestBuilder

Source

pub fn patch(&self, url: &str) -> RequestBuilder

Source

pub fn delete(&self, url: &str) -> RequestBuilder

Source

pub fn head(&self, url: &str) -> RequestBuilder

Trait Implementations§

Source§

impl Clone for HttpClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for HttpClient

Source§

fn default() -> Self

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

Auto Trait Implementations§

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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