Struct brawl_api::http::client::Client

pub struct Client {
    pub auth_key: String,
    // some fields omitted
}

Fields

auth_key: String

Methods

impl Client

Represents an HTTP client which holds the user's API auth key, and is required on every fetch method for authentication. This is usually the starting point for using this library.

See the Client::new method to start.

pub fn new(auth_key: &str) -> Client

Creates a new Client with a given API auth key.

Examples

use brawl_api::Client;

let my_client = Client::new("my auth key");

pub fn inner(&self) -> &ReqClient

(For sync usage) Provides an immutable reference to the inner field.

pub fn inner_mut(&mut self) -> &mut ReqClient

(For sync usage) Provides a mutable reference to the inner field.

pub fn a_inner(&self) -> &AReqClient

(For async usage) Provides an immutable reference to the a_inner field.

pub fn a_inner_mut(&mut self) -> &mut AReqClient

(For async usage) Provides a mutable reference to the a_inner field.

pub fn endpoint_request(&self, endpoint: &str) -> Request

Creates a Request instance for one specific endpoint and returns it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy 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.