Client

Struct Client 

Source
pub struct Client {
    pub config: RequestConfig,
    /* private fields */
}
Expand description

Client for communicating with APIs through HTTP/HTTPS.

When making a HTTP request or starting a websocket connection with this client, a handler that implements RequestHandler is required.

Fields§

§config: RequestConfig

Implementations§

Source§

impl Client

Source

pub async fn request<Q, B, H>( &self, method: Method, url: &str, query: Option<&Q>, body: Option<B>, handler: &H, ) -> Result<H::Successful, RequestError>
where Q: Serialize + ?Sized + Debug, H: RequestHandler<B>,

Makes an HTTP request with the given RequestHandler and returns the response.

It is recommended to use methods like get() because this method takes many type parameters and parameters.

The request is passed to handler before being sent, and the response is passed to handler before being returned. Note, that as stated in the docs for RequestBuilder::query(), parameter query only accepts a sequence of key-value pairs.

Source

pub async fn get<Q, H>( &self, url: &str, query: &Q, handler: &H, ) -> Result<H::Successful, RequestError>
where Q: Serialize + ?Sized + Debug, H: RequestHandler<()>,

Makes an GET request with the given RequestHandler.

This method just calls request(). It requires less typing for type parameters and parameters. This method requires that handler can handle a request with a body of type (). The actual body passed will be None.

For more information, see request().

Source

pub async fn get_no_query<H>( &self, url: &str, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<()>,

Derivation of get().

Source

pub async fn post<B, H>( &self, url: &str, body: B, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<B>,

Makes an POST request with the given RequestHandler.

This method just calls request(). It requires less typing for type parameters and parameters.

For more information, see request().

Source

pub async fn post_no_body<H>( &self, url: &str, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<()>,

Derivation of post().

Source

pub async fn put<B, H>( &self, url: &str, body: B, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<B>,

Makes an PUT request with the given RequestHandler.

This method just calls request(). It requires less typing for type parameters and parameters.

For more information, see request().

Source

pub async fn put_no_body<H>( &self, url: &str, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<()>,

Derivation of put().

Source

pub async fn delete<Q, H>( &self, url: &str, query: &Q, handler: &H, ) -> Result<H::Successful, RequestError>
where Q: Serialize + ?Sized + Debug, H: RequestHandler<()>,

Makes an DELETE request with the given RequestHandler.

This method just calls request(). It requires less typing for type parameters and parameters. This method requires that handler can handle a request with a body of type (). The actual body passed will be None.

For more information, see request().

Source

pub async fn delete_no_query<H>( &self, url: &str, handler: &H, ) -> Result<H::Successful, RequestError>
where H: RequestHandler<()>,

Derivation of delete().

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0§

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() -> Client

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

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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<T> From<T> for T

§

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
§

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.

Source§

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

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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