Struct CharactersClient 

pub struct CharactersClient { /* private fields */ }

Implementations

impl CharactersClient

pub async fn get( &self, request_builder: RequestBuilder, ) -> Result<Vec<Character>, Box<dyn Error + Send + Sync + 'static>>

Receives a configured RequestBuilder an returns a result containing a collection

pub async fn get_by_id( &self, id: usize, limit: usize, ) -> Result<Vec<Character>, Box<dyn Error + Send + Sync + 'static>>

Returns a collection filtered by id and limits the retrieved registries using limit parameter value.

pub async fn get_first_by_id( &self, id: usize, ) -> Result<Character, Box<dyn Error + Send + Sync + 'static>>

Returns the element by Id for this client in Option format.

impl CharactersClient

pub async fn get_by_game_id( &self, game_id: usize, limit: usize, ) -> Result<Vec<Character>, Box<dyn Error + Send + Sync + 'static>>

Retrieves the characters for a given game id

Examples

use igdb_rs::client::IGDBClient;

let igdb_client = IGDBClient::new("api-key");
let characters_client = igdb_client.characters();
///Retrieve 8 first characters for The Witcher 3 game
let characters = characters_client.get_by_game_id(1942, 8);