Struct Client 

pub struct Client { /* private fields */ }

A simple extendable client wrapper for http request with extra url sanitization.

Implementations

impl Client

pub fn set_front_policy(&mut self, policy: FrontPolicy)

Set the policy for enabling fronting. If fronting was previously unset this will set it, and make it possible to enable (i.e FrontPolicy::Off will not enable it).

Calling this function sets a custom policy for this client, disconnecting it from the shared fronting policy – i.e. changes applied through Client::set_shared_front_policy will not be impact this client.

pub fn use_shared_front_policy(&mut self)

Set the fronting policy for this client to follow the shared policy.

pub fn set_shared_front_policy(policy: FrontPolicy)

Set the fronting policy for all clients using the shared policy.

impl Client

pub fn new(base_url: Url, timeout: Option<Duration>) -> Self

Create a new http Client

pub fn new_url<U>( url: U, timeout: Option<Duration>, ) -> Result<Self, HttpClientError>

where U: IntoUrl,

Attempt to create a new http client from a something that can be converted to a URL

pub fn builder<U>(url: U) -> Result<ClientBuilder, HttpClientError>

where U: IntoUrl,

Creates a ClientBuilder to configure a Client.

This is the same as ClientBuilder::new().

pub fn change_base_urls(&mut self, new_urls: Vec<Url>)

Update the set of hosts that this client uses when sending API requests.

pub fn clone_with_new_url(&self, new_url: Url) -> Self

Create new instance of Client using the provided base url and existing client config

pub fn current_url(&self) -> &Url

Get the currently configured host that this client uses when sending API requests.

pub fn current_url_str(&self) -> &str

The wire-level request target this client is currently pointed at: the active host’s own URL, or - while fronting has selected one - that front’s URL instead. See Self::current_front_host for just the front’s host.

pub fn current_front_host(&self) -> Option<&str>

The front host (domain or IP) currently selected for the active base url, if fronting has selected one for it.

pub fn base_urls(&self) -> &[Url]

Get the currently configured host that this client uses when sending API requests.

pub fn base_urls_mut(&mut self) -> &mut [Url]

Get a mutable reference to the hosts that this client uses when sending API requests.

pub fn change_retry_limit(&mut self, limit: usize)

Change the currently configured limit on the number of retries for a request.

Trait Implementations

impl ApiClientCore for Client

fn create_request<P, B, K, V>( &self, method: Method, path: P, params: Params<'_, K, V>, body: Option<&B>, ) -> Result<RequestBuilder, HttpClientError>

where P: RequestPath, B: Serialize + ?Sized, K: AsRef<str>, V: AsRef<str>,

Create an HTTP request using the host configured in this client.

fn send<'life0, 'async_trait>( &'life0 self, request: RequestBuilder, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>

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

Send a created HTTP request.

fn maybe_rotate_hosts(&self, offending: Option<Url>)

If multiple base urls are available rotate to next (e.g. when the current one resulted in an error)

fn maybe_enable_fronting(&self, domain: Option<&str>, context: impl Debug)

If the fronting policy for the client is set to OnRetry or ConfiguredRetry this function will enable fronting if not already enabled. domain should be the host of the URL that triggered the failure, and is used by ConfiguredRetry to track failures per domain.

fn create_request_endpoint<B, S>( &self, method: Method, endpoint: S, body: Option<&B>, ) -> Result<RequestBuilder, HttpClientError>

where B: Serialize + ?Sized, S: AsRef<str>,

Create an HTTP request using the host configured in this client and an API endpoint (i.e. "/api/v1/mixnodes?since=12345"). If the provided endpoint fails to parse as path (and optionally query parameters).

fn send_request<'life0, 'life1, 'life2, 'async_trait, P, B, K, V>( &'life0 self, method: Method, path: P, params: Params<'life1, K, V>, json_body: Option<&'life2 B>, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>

where P: RequestPath + Send + Sync + 'async_trait, B: Serialize + ?Sized + Sync + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create and send a created HTTP request.

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.