Struct Client

pub struct Client { /* private fields */ }

The IGDB API client.

Implementations

impl Client

pub fn new(client_id: &str, client_secret: &str) -> Self

Create a new client.

pub fn with_endpoint(self, endpoint: &str) -> Self

Set a custom endpoint for use with the CORS proxy or your own proxy.

use igdb_api_rust::client::Client;
let mut client = Client::new("test","test").with_endpoint("https://example.com/v4");

pub async fn request<M: Message + Default>( &mut self, query: &ApicalypseBuilder, ) -> Result<M, IGDBApiError>

Request the IGDB API for a protobuf response.

pub async fn request_raw<M: Message + Default>( &mut self, query: &str, ) -> Result<M, IGDBApiError>

Request the IGDB API for a protobuf response. This is the raw version of the request method. It allows you to pass a query string directly.

#[tokio::main]
async fn main() {
  use igdb_api_rust::client::Client;
  let mut client = Client::new("test","test");
  let query = "fields name; limit 5;";
  let response = client.request_raw::<igdb_api_rust::igdb::Game>(query).await;
}

pub async fn request_count<M: Message + Default>( &mut self, query: &ApicalypseBuilder, ) -> Result<Count, IGDBApiError>

Request the IGDB API for a protobuf response for the count endpoint.

#[tokio::main]
async fn main() {
  use igdb_api_rust::apicalypse_builder::ApicalypseBuilder;
  use igdb_api_rust::client::Client;
  let mut client = Client::new("test","test");
  let query = ApicalypseBuilder::default().filter("id > 1337").clone();
  let response = client.request_count::<igdb_api_rust::igdb::Game>(&query).await;
  println!("{:?}", response);

}

pub async fn request_count_raw<M: Message + Default>( &mut self, query: &str, ) -> Result<Count, IGDBApiError>

Request the IGDB API for a protobuf response for the count endpoint. This is the raw version of the request_count method. It allows you to pass a query string directly.

#[tokio::main]
async fn main() {
  use igdb_api_rust::client::Client;
  let mut client = Client::new("test","test");
  let query = "w id > 1337";
  let response = client.request_count_raw::<igdb_api_rust::igdb::Game>(query).await;
}

Trait Implementations

impl Default for Client

fn default() -> Self

Get a client with the credentials from the environment variables.