Struct Client

pub struct Client {
    pub http: Client,
    pub base: String,
}

A client based on the reqwest::Client which can be used for executing Endpoints. A backing instance of a reqwest::Client is used to increase performance and to save certain characteristics across sessions. A base URL is required and is used to qualify the full path of any Endpoints which are executed by this client.

Example

use rustify::clients::reqwest::Client;
use rustify::Endpoint;
use rustify_derive::Endpoint;
use serde::Serialize;

#[derive(Debug, Endpoint, Serialize)]
#[endpoint(path = "my/endpoint")]
struct MyEndpoint {}

let client = Client::default("http://myapi.com");
let endpoint = MyEndpoint {};
let result = endpoint.exec(&client).await;

Fields

http: Client

base: String

Implementations

impl Client

pub fn new(base: &str, http: Client) -> Self

Creates a new instance of Client using the provided parameters.

pub fn default(base: &str) -> Self

Creates a new instance of Client with a default instance of reqwest::Client.

Trait Implementations

impl Client for Client

fn base(&self) -> &str

Returns the base URL the client is configured with. This is used for creating the fully qualified URLs used when executing Endpoints.

fn send<'life0, 'async_trait>( &'life0 self, req: Request<Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<Response<Vec<u8>>, ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the given Request and returns a Response. Implementations should consolidate all errors into the ClientError type.

fn execute<'life0, 'async_trait>( &'life0 self, req: Request<Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<Response<Vec<u8>>, ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This method provides a common interface to Endpoints for execution.