Struct igdb_rs::request_builder::RequestBuilder

pub struct RequestBuilder { /* fields omitted */ }

Request Builder struct

Methods

impl RequestBuilder

pub fn new() -> RequestBuilder

Creates a new Request Builder It can also be created using IGDBClient::create_request();

Examples

use igdb_rs::request_builder::RequestBuilder;

let mut request = RequestBuilder::new();

use igdb_rs::client::IGDBClient;

let mut request = IGDBClient::create_request();

impl RequestBuilder

This struct allows creating a custom and parameterized request to IGDB endpoints by using it's filter methods

pub fn all_fields(&mut self) -> &mut Self

Requests all field for the given query

Examples

use igdb_rs::client::IGDBClient;

let mut request = IGDBClient::create_request();
request
.all_fields()
.search("Conan")
.limit(1);

pub fn add_field<S: Into<String>>(&mut self, field: S) -> &mut Self

Adds one field to be retrieved for this request Requests all field for the given query

Examples

use igdb_rs::client::IGDBClient;

let mut request = IGDBClient::create_request();
request
.add_field("description")
.add_field("name")
.search("Borderlands");

pub fn add_fields<I, T>(&mut self, iter: I) -> &mut Self where
    I: IntoIterator<Item = T>,
    T: Into<String>, 

Adds several fields for this request by using an Iterator object

Examples

use igdb_rs::client::IGDBClient;

let mut request = IGDBClient::create_request();
request
.add_fields(vec!["description", "name", "summary"])
.contains("name", "Mass Effect");

pub fn add_where_in(&mut self, field: String, values: Vec<String>) -> &mut Self

Adds a filter representing a group of elements like WHERE IN statement in SQL

Examples

use igdb_rs::client::IGDBClient;

let mut request = IGDBClient::create_request();
request
.all_fields()
.add_where_in("name".to_owned(), vec!["5".to_owned(), "8".to_owned(), "10".to_owned()])
.limit(5);

pub fn add_where<L: Into<String>, R: Into<String>>(
    &mut self,
    field: L,
    equality: Equality,
    clause: R
) -> &mut Self

Adds a filter under using given condition

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::request_builder::Equality;

let mut request = IGDBClient::create_request();
request
.add_where("id", Equality::GreaterOrEqual, "20")
.add_where("onlinemax", Equality::LessOrEqual, "12")
.contains("name", "Fighter");

pub fn limit(&mut self, limit: usize) -> &mut Self

Limits the registries obtained from the server

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::request_builder::Equality;

let mut request = IGDBClient::create_request();
request
.all_fields()
.limit(8);

pub fn contains<S: Into<String>>(&mut self, field: S, value: S) -> &mut Self

Return the registries containing the given value for the specified field. Can start and end with anything

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::request_builder::Equality;

let mut request = IGDBClient::create_request();
request
.all_fields()
.limit(8);

pub fn search<S: Into<String>>(&mut self, search: S) -> &mut Self

Search based on name, results are sorted by similarity to the given search string. Searchable endpoints: - Characters - Collections - Games - People - Platforms - Themes

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::request_builder::Equality;

let mut request = IGDBClient::create_request();
request
.search("Zelda")
.limit(8);

pub fn sort_by<S: Into<String>>(
    &mut self,
    field: S,
    order: OrderBy
) -> &mut Self

Sorts the query by the given field

Examples

use igdb_rs::client::IGDBClient;
use igdb_rs::request_builder::{Equality, OrderBy};

let mut request = IGDBClient::create_request();
request
.add_field("name")
.sort_by("name", OrderBy::Descending)
.limit(8);

Trait Implementations

impl Default for RequestBuilder

fn default() -> Self

Returns the "default value" for a type.

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.