Struct AppInfo 

#[non_exhaustive]
pub struct AppInfo {
    pub name: &'static str,
    pub id: &'static str,
    pub version: &'static str,
    pub publisher: &'static str,
    pub storage: &'static str,
    pub build: u32,
    pub window_icon: Option<WindowIcon>,
}

Who a game is. Build it with AppInfo::new and the with_ setters: a struct literal doesn’t compile outside this crate, so a new field never breaks a game (ADR-0039).

let app = shuyi_platform::AppInfo {
    name: "A game",
    id: "com.example.a-game",
    version: "0.1.0",
    publisher: "",
    storage: "com.example.a-game",
    build: 1,
    window_icon: None,
};

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: &'static str

The name players see: the window’s title and the loading card’s line.

id: &'static str

Its reverse-DNS id, unique to the game (com.example.moon-garden).

version: &'static str

Its version, MAJOR.MINOR.PATCH (semver).

publisher: &'static str

Who publishes it; empty if no one is named.

storage: &'static str

The name its saves are kept under: the folder in the OS’s data folder on native, the prefix of every localStorage key on the web. Never change it after a release, or every player’s saves and settings are lost.

build: u32

A number that only grows from one build handed out to the next, where a target asks for one beside the version.

window_icon: Option<WindowIcon>

The window’s icon, where a backend shows one; None for none. shuyi app-info makes it from shuyi.ron’s app.icon.

Implementations

impl AppInfo

pub const fn new( name: &'static str, id: &'static str, version: &'static str, ) -> AppInfo

The game called name, with the id id, at version version: its saves kept under its id, at build 1, with no publisher named.

pub const fn with_storage(self, storage: &'static str) -> AppInfo

The game with its saves kept under storage (storage).

pub const fn with_build(self, build: u32) -> AppInfo

The game at build build (build).

pub const fn with_publisher(self, publisher: &'static str) -> AppInfo

The game published by publisher.

pub const fn with_window_icon(self, icon: Option<WindowIcon>) -> AppInfo

The game with icon as its window’s icon (None for none, window_icon).

Trait Implementations

impl Clone for AppInfo

fn clone(&self) -> AppInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AppInfo

impl Debug for AppInfo

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

Formats the value using the given formatter.

impl Eq for AppInfo

impl PartialEq for AppInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AppInfo