Struct Client

pub struct Client { /* private fields */ }

The HTTP client able to call the endpoints.

The client will automatically call the required method for an endpoint with the optional data to ensure security needs.

Implementations

impl Client

pub fn new(host: String, api_key: impl Into<Option<String>>) -> Self

Create a new client with an optional API key.

pub fn with_signed( self, key: String, recv_window: impl Into<Option<u16>>, ) -> Self

Add a secret key to sign the queries.

An additional parameter, recv_window, may be sent to specify the number of milliseconds after timestamp the request is valid for. If recv_window will not be sent, it defaults to 5_000.

pub async fn request<T: DeserializeOwned, E: Endpoint>( &self, endpoint: &E, query: &[(&dyn ToString, &dyn ToString)], ) -> Result<T>

Request data from endpoint.

For better experience use the url_query! macro to construct key-value pairs of the URL query.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.