Skip to main content

HttpClient

Struct HttpClient 

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

A configured outbound HTTP client. Cheap to clone (wraps an Arc’d pool).

Implementations§

Source§

impl HttpClient

Source

pub fn api() -> HttpClientBuilder

Builder for an API-style buffered client.

Source

pub fn sse() -> HttpClientBuilder

Builder for an SSE streaming client.

Source

pub fn builder(profile: Profile) -> HttpClientBuilder

Builder for an explicit profile.

Source

pub fn profile(&self) -> Profile

The profile this client was built with.

Source

pub async fn get(&self, url: &str) -> Result<BoundedResponse, HttpError>

GET returning a buffered, size-bounded response (error statuses are returned as HttpError::Status).

Source

pub async fn get_with( &self, url: &str, opts: RequestOptions, ) -> Result<BoundedResponse, HttpError>

GET with per-request options.

Source

pub async fn post_json( &self, url: &str, body: &Value, ) -> Result<BoundedResponse, HttpError>

POST a JSON body returning a buffered, size-bounded response.

Source

pub async fn post_json_with( &self, url: &str, body: &Value, opts: RequestOptions, ) -> Result<BoundedResponse, HttpError>

POST a JSON body with per-request options.

Source

pub async fn post_multipart_with( &self, url: &str, form: Form, opts: RequestOptions, ) -> Result<BoundedResponse, HttpError>

POSTs a multipart/form-data body with per-request options.

A multipart form cannot be replayed (parts may stream from non-cloneable sources), so this performs exactly ONE send attempt: no retries, not even on a connect failure or retriable status. The total deadline, cancellation token and response size bound still apply. The response body is buffered like HttpClient::post_json_with.

Source

pub async fn open_sse( &self, url: &str, body: Option<&Value>, opts: RequestOptions, ) -> Result<SseStream, HttpError>

Opens an SSE byte stream. Retries cover only stream establishment; once a successful response header set is returned the stream runs to completion without reconnecting.

Named open_sse (not sse) because HttpClient::sse is the SSE-profile builder constructor.

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 Debug for HttpClient

Source§

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

Formats the value using the given formatter. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
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