unity-formats 0.1.0

Reads Unity games' data files: SerializedFiles, scenes, meshes, textures, shader programs and Animator data
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

//! Unity editor versions, as files write them (`6000.3.12f1`) and as type tree packages order them.

use std::fmt;

use crate::{Result, invalid};

/// A Unity version packed into one ordered number: major (16 bits), minor (16), build (16), release type (8: a 0,
/// b 1, c 2, f 3, p 4, x 5), number (8). A version without a release type (`5.0.0`) is final, number 0.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct UnityVersion(pub u64);

const TYPES: [char; 6] = ['a', 'b', 'c', 'f', 'p', 'x'];

impl UnityVersion {
    /// Pack a version from its parts (`kind` 0 to 5: a, b, c, f, p, x).
    pub fn new(major: u16, minor: u16, build: u16, kind: u8, number: u8) -> Self {
        UnityVersion(
            u64::from(major) << 48
                | u64::from(minor) << 32
                | u64::from(build) << 16
                | u64::from(kind) << 8
                | u64::from(number),
        )
    }

    /// `major.minor.build[type number]`, e.g. `6000.3.12f1`; anything after the number is ignored.
    pub fn parse(s: &str) -> Result<Self> {
        let bad = || invalid(format!("Unity version {s:?}"));
        let mut parts = s.splitn(3, '.');
        let major: u16 = parts.next().and_then(|p| p.parse().ok()).ok_or_else(bad)?;
        let minor: u16 = parts.next().and_then(|p| p.parse().ok()).ok_or_else(bad)?;
        let rest = parts.next().ok_or_else(bad)?;
        let digits = rest.find(|c: char| !c.is_ascii_digit()).unwrap_or(rest.len());
        let build: u16 = rest.get(..digits).and_then(|d| d.parse().ok()).ok_or_else(bad)?;
        let tail = rest.get(digits..).ok_or_else(bad)?;
        let Some(t) = tail.chars().next() else {
            return Ok(Self::new(major, minor, build, 3, 0));
        };
        let kind = TYPES
            .iter()
            .position(|&c| c == t)
            .and_then(|k| u8::try_from(k).ok())
            .ok_or_else(bad)?;
        let num = tail.get(t.len_utf8()..).ok_or_else(bad)?;
        let n = num.find(|c: char| !c.is_ascii_digit()).unwrap_or(num.len());
        let number: u8 = if n == 0 {
            0
        } else {
            num.get(..n).and_then(|d| d.parse().ok()).ok_or_else(bad)?
        };
        Ok(Self::new(major, minor, build, kind, number))
    }

    /// The 16 bits at bit `shift`.
    fn field(self, shift: u32) -> u16 {
        u16::try_from((self.0 >> shift) & 0xFFFF).unwrap_or_default()
    }

    /// The major version (`6000`, `2019`).
    pub fn major(self) -> u16 {
        self.field(48)
    }
    /// The minor version.
    pub fn minor(self) -> u16 {
        self.field(32)
    }
    /// The build number (`12` of `6000.3.12f1`).
    pub fn build(self) -> u16 {
        self.field(16)
    }
}

impl fmt::Display for UnityVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let kind = TYPES.get(((self.0 >> 8) & 0xFF) as usize).copied().unwrap_or('?');
        write!(
            f,
            "{}.{}.{}{kind}{}",
            self.major(),
            self.minor(),
            self.build(),
            self.0 & 0xFF
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn versions_parse_and_order() {
        let v = UnityVersion::parse("6000.3.12f1").unwrap();
        assert_eq!(v, UnityVersion::new(6000, 3, 12, 3, 1));
        assert_eq!(v.to_string(), "6000.3.12f1");
        assert_eq!(
            UnityVersion::parse("5.0.0").unwrap(),
            UnityVersion::new(5, 0, 0, 3, 0)
        );
        assert!(UnityVersion::parse("2022.3.1b2").unwrap() < UnityVersion::parse("2022.3.1f1").unwrap());
        assert!(UnityVersion::parse("2022.3.1f1-custom").is_ok());
        for bad in ["", "6000", "6000.3", "6000.3.x", "6000.3.12q1"] {
            assert!(UnityVersion::parse(bad).is_err(), "{bad}");
        }
    }
}