Struct gw2api::client::Client

pub struct Client { /* fields omitted */ }

Client that performs requests to the API

Implementations

impl Client

pub fn new() -> Client

Creates a new Client to interface with the Guild Wars 2 API.

pub fn set_api_key(self, api_key: String) -> Client

Sets the API key of the client with a valid Guild Wars 2 API key.

pub fn set_lang(self, lang: Localisation) -> Client

Sets the language to be used in responses, applies to item names and what not.

pub fn request<T>(&self, url: &str) -> Result<T, ApiError> where
    T: DeserializeOwned, 

Make a request to the Guild Wars 2 API with the given url (which has to include version) as endpoint.

pub fn authenticated_request<T>(&self, url: &str) -> Result<T, ApiError> where
    T: DeserializeOwned, 

Make an authenticated request to the Guild Wars 2 API with the given url (which has to include version) as endpoint. This requires that the api_key field of the client is set, otherwise it panics.

This function may fail depending on what the settings of the API key itself are, since you can limit what resources a certain key may access. In that case the function will return an error.

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

Returns an Option containing a string slice of the Guild Wars 2 API key for the Client object if it exists, otherwise None is returned in the Option.

pub fn lang(&self) -> Option<&Localisation>

Returns an Option to a reference of the Localisation enum object if given, otherwise None is returned in the Option.