Enum Filter

pub enum Filter {
    Statuses(Vec<String>),
    Users(Vec<String>),
    Systems(Vec<String>),
    ClassNames(Vec<String>),
    StartYear(i32),
    EndYear(i32),
    GenreNames(Vec<String>),
    TagNames(Vec<String>),
    FlagNames(Vec<String>),
    AuthorIds(Vec<i32>),
    ShowObsoleted(bool),
    GameIds(Vec<i32>),
    Games(Vec<i32>),
    GameGroupIds(Vec<i32>),
    PageSize(u32),
    CurrentPage(u32),
    Sorts(Vec<String>),
}

Some endpoints can use these filters to refine what data is returned.

Endpoints that support filters will accept a Vec<QueryFilter> argument. The order of filters doesn’t matter. Using multiple of the same kind of filter is not recommended, and may produce undefined behavior. Each endpoint may not support all available filter types, refer to the docs on each function to know what is supported. Any unsupported filters will be quietly ignored.

Variants

Statuses(Vec<String>)

Users(Vec<String>)

Systems(Vec<String>)

ClassNames(Vec<String>)

StartYear(i32)

EndYear(i32)

GenreNames(Vec<String>)

TagNames(Vec<String>)

FlagNames(Vec<String>)

AuthorIds(Vec<i32>)

ShowObsoleted(bool)

GameIds(Vec<i32>)

Games(Vec<i32>)

GameGroupIds(Vec<i32>)

PageSize(u32)

CurrentPage(u32)

Sorts(Vec<String>)

Implementations

impl Filter

pub fn as_query(&self) -> (&'static str, String)

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Filter

fn eq(&self, other: &Filter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Filter

impl StructuralPartialEq for Filter