Struct igdb_rs::client::ScreenshotsClient

pub struct ScreenshotsClient { /* fields omitted */ }

Methods

impl ScreenshotsClient

pub async fn get<'_>(
    &'_ self,
    request_builder: RequestBuilder
) -> Result<Vec<Screenshot>, 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<Screenshot>, 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) -> Option<Screenshot>

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

impl ScreenshotsClient

pub async fn download_by_id<'_, S: Into<String>>(
    &'_ self,
    id: usize,
    path: S,
    media_quality: MediaQuality
) -> Result<(), Error>

Download to the given path the resource specified in the Id MediaQuality is an enum that specifies different image sizes

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::media_quality::MediaQuality;
let client = IGDBClient::new("key");
let screenshot_client = client.screenshots();
screenshot_client.download_by_id(12400, "screen.jpg".to_string(), MediaQuality::ScreenshotHuge,);

impl ScreenshotsClient

pub async fn get_by_game_id<'_>(
    &'_ self,
    game_id: usize,
    limit: usize
) -> Option<Vec<Screenshot>>

Receives a game_id and a limit of registries and returns an Option of elements