cytryna 0.1.3

A library for handling 3DS file types
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use std::mem;

use crate::{CytrynaError, CytrynaResult};
use bitflags::bitflags;
use static_assertions::assert_eq_size;

#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(transparent)]
pub struct MaybeTitleId {
    raw: u64,
}

impl MaybeTitleId {
    #[must_use]
    pub fn to_titleid(self) -> CytrynaResult<TitleId> {
        TitleId::from_u64(self.raw)
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(transparent)]
pub struct MaybeTitleIdBe {
    raw: u64,
}

impl MaybeTitleIdBe {
    #[must_use]
    pub fn to_titleid(self) -> CytrynaResult<TitleId> {
        TitleId::from_u64(self.raw.swap_bytes())
    }
    #[must_use]
    pub fn to_le(self) -> MaybeTitleId {
        MaybeTitleId {
            raw: self.raw.swap_bytes(),
        }
    }
    #[must_use]
    pub fn to_bytes(self) -> [u8; 8] {
        unsafe { mem::transmute(self) }
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
#[repr(C)]
pub struct TitleId {
    id: u32,
    category: Category,
    plat: Platform,
}
assert_eq_size!(u64, TitleId);

impl TitleId {
    #[must_use]
    pub fn is_null(&self) -> bool {
        self.to_u64() == 0
    }
    #[must_use]
    pub fn to_u64(self) -> u64 {
        unsafe { mem::transmute(self) }
    }
    #[must_use]
    pub fn from_u64(what: u64) -> CytrynaResult<TitleId> {
        let platform = (what & 0x0000_0000_0000_ffff) as u16;

        if platform >= 6 || platform == 0 {
            return Err(CytrynaError::EnumValueOutOfRange("smdh::Platform"));
        }

        Ok(unsafe { mem::transmute(what) })
    }
    #[must_use]
    pub fn id(&self) -> u32 {
        self.id
    }
    #[must_use]
    pub fn category(&self) -> Category {
        self.category
    }
    #[must_use]
    pub fn plat(&self) -> Platform {
        self.plat
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[repr(u16)]
pub enum Platform {
    Wii = 1,
    Dsi = 3,
    Ctr = 4,
    Wiiu = 5,
}

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq)]
    pub struct Category: u16 {
        const NORMAL = 0x0;
        const DLP_CHILD = 0x1;
        const DEMO = 0x2;
        const CONTENTS = 0x3;
        const ADDON_CONTENTS = 0x4;
        const PATCH = 0x6;
        const CANNOT_EXECUTION = 0x8;
        const SYSTEM = 0x10;
        const REQUIRE_BATCH_UPDATE = 0x20;
        const NOT_REQUIRE_USER_APPROVAL = 0x40;
        const NOT_REQUIRE_RIGHT_FOR_MOUNT = 0x80;
        const CAN_SKIP_CONVERT_JUMP_ID = 0x100;
        const TWL = 0x8000;

        // https://www.3dbrew.org/wiki/Title_list#CTR_System_Titles
        const SYSTEM_APPLICATION = Self::NORMAL.bits() | Self::SYSTEM.bits();
        const SYSTEM_CONTENT = Self::CONTENTS.bits() | Self::CANNOT_EXECUTION.bits() | Self::SYSTEM.bits();
        const SHARED_CONTENT = Self::CONTENTS.bits() | Self::CANNOT_EXECUTION.bits() | Self::NOT_REQUIRE_RIGHT_FOR_MOUNT.bits() | Self::SYSTEM.bits();
        const AUTO_UPDATE_CONTENT = Self::CONTENTS.bits() | Self::CANNOT_EXECUTION.bits() | Self::NOT_REQUIRE_USER_APPROVAL.bits() | Self::NOT_REQUIRE_RIGHT_FOR_MOUNT.bits() | Self::SYSTEM.bits();
        const APPLET = Self::NORMAL.bits() | Self::SYSTEM.bits() | Self::REQUIRE_BATCH_UPDATE.bits();
        const BASE = Self::NORMAL.bits() | Self::SYSTEM.bits() | Self::REQUIRE_BATCH_UPDATE.bits() | Self::CAN_SKIP_CONVERT_JUMP_ID.bits();
        const FIRMWARE = Self::NORMAL.bits() | Self::CANNOT_EXECUTION.bits() | Self::SYSTEM.bits() | Self::REQUIRE_BATCH_UPDATE.bits() | Self::CAN_SKIP_CONVERT_JUMP_ID.bits();

        const _ = !0;
    }
}