galaxy_save_core 0.2.0

Defining common types and traits used in the save data of Super Mario Galaxy and Super Mario Galaxy 2
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
42
43
44
45
46
47
48

use binrw::binrw;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::hash::{HashCode, HashCode16};

/// A key-value pair for a 16-bit unsigned integer.
#[binrw]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug)]
pub struct GameEventValue {
    /// The hashed key, truncated to the least significant 16 bits.
    key: HashCode16,

    /// The associated value.
    value: u16,
}

impl GameEventValue {
    /// Creates a new `GameEventValue`.
    pub fn new(key: impl Into<HashCode>, value: u16) -> Self {
        let key = HashCode16::from(key.into());

        Self { key, value }
    }

    /// Returns the hashed key.
    const fn key(&self) -> HashCode16 {
        self.key
    }

    /// Returns a reference to the associated value.
    pub const fn value(&self) -> &u16 {
        &self.value
    }

    /// Returns a mutable reference to the associated value.
    pub const fn value_mut(&mut self) -> &mut u16 {
        &mut self.value
    }
}

impl PartialEq<HashCode> for GameEventValue {
    fn eq(&self, other: &HashCode) -> bool {
        self.key() == *other
    }
}