Struct libpobsd::models::game::Game

pub struct Game {

    pub uid: u32,
    pub name: String,
    pub cover: Option<String>,
    pub engine: Option<String>,
    pub setup: Option<String>,
    pub runtime: Option<String>,
    pub stores: Option<StoreLinks>,
    pub hints: Option<String>,
    pub genres: Option<Vec<String>>,
    pub tags: Option<Vec<String>>,
    pub year: Option<String>,
    pub devs: Option<Vec<String>>,
    pub publis: Option<Vec<String>>,
    pub version: Option<String>,
    pub status: GameStatus,
    pub added: NaiveDate,
    pub updated: NaiveDate,
    pub igdb_id: Option<String>,
}

Representation of a game of the PlayOnBSD database.

It also includes an additional Game::uid field derived from the name of the game as well as the date to which the game was added to the database. It therefore provides an unique identifier under the assumption that no game with the same name will be added the same date into the database.

The name of some fields differs from the one used in the database itself: Genre and Store are plural since there can be more than one item for each and Pub translate to publi since pub is a reserved keyword in Rust.

Display

The Game struct implement the core::fmt::Display trait and will be displayed as it would appear in the PlayOnBSD database.

PartialOrd

The Game struct implements the core::cmp::PartialOrd trait and Game objects are ordered according to their name (without The or A).

Fields

uid: u32

Unique identifier generated from the name and added fields

name: String

Name of the game.

cover: Option<String>

Cover of the game.

engine: Option<String>

Engine used by the game.

setup: Option<String>

Step(s) to setup the game.

runtime: Option<String>

Executable in the package.

stores: Option<StoreLinks>

Vector with store urls.

hints: Option<String>

Hints (as the name imply).

genres: Option<Vec<String>>

Vector of genres associated with the game.

tags: Option<Vec<String>>

Vector of tags associated with the game.

year: Option<String>

Released year (can be text such as “early access”.

devs: Option<Vec<String>>

Developer.

publis: Option<Vec<String>>

Publisher.

version: Option<String>

Version of the game.

status: GameStatus

When tested on -current.

added: NaiveDate

When added

updated: NaiveDate

When updated

igdb_id: Option<String>

IGDB Id of the game

Implementations

impl<'a> Game

pub fn new() -> Self

Create a new Game. Equivalent to Default.

pub fn name_contains(&self, pattern: &str, search_type: &SearchType) -> bool

Returns true if the name field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn engine_contains(&self, pattern: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn runtime_contains(&self, pattern: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn year_contains(&self, pattern: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn genres_contains(&self, value: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn tags_contains(&self, value: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn devs_contains(&self, value: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn publis_contains(&self, value: &str, search_type: &SearchType) -> bool

Returns true if the chosen field of a Game contains the given pattern, false otherwise. The search can be case sensitive or not depending on the SearchType variant.

pub fn status_is(&self, status: &impl AsRef<Status>) -> bool

Return true if the Status of the Game correspond to a given Status, false otherwise. Note that the argument provided can be Status or crate::models::GameStatus.

pub fn get_steam_id(&self) -> Option<usize>

Returns the Steam id of a Game if it has any.

Trait Implementations

impl AsRef<Game> for Game

fn as_ref(&self) -> &Game

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Game

fn clone(&self) -> Game

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Game

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

Formats the value using the given formatter.

impl Default for Game

fn default() -> Game

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Game

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Game

Displays the game as it would appears in the database. See https://github.com/playonbsd/OpenBSD-Games-Database for details.

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

Formats the value using the given formatter.

impl Ord for Game

fn cmp(&self, other: &Game) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Game

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Game

fn partial_cmp(&self, other: &Game) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Game) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Game) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Game) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Game) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Game

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Game

impl StructuralPartialEq for Game