Skip to main content

Client

Struct Client 

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

An async client for sending HTTP QUERY requests.

The client wraps a reqwest::Client; clone it freely (it is cheap and shares the underlying connection pool).

Redirects are handled per RFC 10008 §2.5: 301, 302, 307 and 308 re-issue the QUERY with its body, while 303 switches to GET. To make this possible the client built by Client::new disables reqwest’s own redirect following.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Creates a client with a default reqwest::Client (redirects disabled so QUERY redirects can be handled per RFC 10008 §2.5).

Source

pub fn with_http_client(http: HttpClient) -> Self

Creates a client wrapping an existing reqwest::Client.

For RFC 10008 §2.5 redirect handling to work correctly, http must be built with redirects disabled (reqwest::redirect::Policy::none()); otherwise reqwest follows redirects itself and downgrades QUERY to GET.

Source

pub fn with_base_url(self, base: &str) -> Result<Self>

Sets a base URL used to resolve relative request URLs.

Source

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

Sets the maximum number of redirects to follow (default DEFAULT_MAX_REDIRECTS).

Source

pub async fn query( &self, url: &str, content_type: &str, body: impl Into<Vec<u8>>, ) -> Result<Response>

Sends a QUERY request with a raw body and the given content type.

Redirects are followed per RFC 10008 §2.5: 301/302/307/308 re-issue the QUERY with the body; 303 switches to GET. Exceeding Client::with_max_redirects returns Error::TooManyRedirects.

Source

pub async fn query_string( &self, url: &str, content_type: &str, body: impl Into<String>, ) -> Result<Response>

Sends a QUERY request with a string body.

Source

pub async fn query_json<T: Serialize + ?Sized>( &self, url: &str, value: &T, ) -> Result<Response>

Sends a QUERY request whose body is value serialized to JSON.

Source

pub async fn query_json_into<T, R>(&self, url: &str, value: &T) -> Result<R>

Sends a JSON QUERY request and decodes a JSON response, validating the status first.

Source

pub async fn options(&self, url: &str) -> Result<Discovery>

Issues an OPTIONS request and reports QUERY support from the response.

Source

pub async fn fetch_result(&self, resp: &Response) -> Result<Response>

Performs a GET on the stored result of the query (Content-Location, RFC 10008 §2.3), resolved against the original request URL.

Source

pub async fn fetch_equivalent(&self, resp: &Response) -> Result<Response>

Performs a GET on the equivalent resource (Location, RFC 10008 §2.4), which re-runs the query without resending the body.

Trait Implementations§

Source§

impl Clone for Client

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 Client

Source§

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

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

impl Default for Client

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