Struct ScreenshotsClient

pub struct ScreenshotsClient { /* private fields */ }

Implementations

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, ) -> Result<Screenshot, Box<dyn Error + Send + Sync + 'static>>

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<(), Box<dyn Error + Send + Sync + 'static>>

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

pub async fn get_resource_by_id( &self, id: usize, media_quality: MediaQuality, ) -> Result<Vec<u8>, Box<dyn Error + Send + Sync + 'static>>

Retrieves content in bytes for the given media resource 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.get_resource_by_id(12400, 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