chip8_db 2.1.0

Embed the CHIP-8 DB in your own CHIP-8 implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Defintions related to CHIP-8 quirks.

use serde::{Deserialize, Serialize};

/// An ID for each quirk, by which to reference it in a [Program] or [Platform].
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum Quirk {
    Shift,
    MemoryIncrementByX,
    MemoryLeaveIUnchanged,
    Wrap,
    Jump,
    #[serde(rename = "vblank")]
    VBlank,
    Logic,
}

/// A detailed breakdown of the meaning of a [Quirk].
#[cfg(feature = "extra-data")]
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct QuirkDetails {
    /// An ID for each quirk, by which to reference it in a [Program] or [Platform].
    pub id: Quirk,

    /// The name of this quirk.
    pub name: String,

    /// A description of the quirk and why it exists.
    pub description: Option<String>,

    /// Whether or not this quirk should be enabled by default.
    pub default: bool,

    /// A description of CHIP-8 behavior when this quirk is enabled.
    pub if_true: String,

    /// A description of CHIP-8 behavior when this quirk is not enabled.
    pub if_false: String,
}