Struct igdb_rs::client::CharacterClient

pub struct CharacterClient { /* fields omitted */ }

Methods

impl CharacterClient

pub async fn get<'_>(
    &'_ self,
    request_builder: RequestBuilder
) -> Result<Vec<Character>, Exception>

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>, Exception>

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) -> Option<Character>

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

impl CharacterClient

pub async fn get_by_game_id<'_>(
    &'_ self,
    game_id: usize,
    limit: usize
) -> Result<Vec<Character>, Exception>

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);