osb 0.3.0

A fast, fully-fledged, scalable and secure implementation of the .osb storyboard file format
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

use std::fmt;

/// `Layer`s as defined in the [official osu! specifications](https://osu.ppy.sh/wiki/en/Storyboard_Scripting/General_Rules#layers)
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Layer {
    /// Default and preferred layer
    Background,
    /// Storyboard elements will appear when the player is on the verge of
    /// losing
    ///
    /// Appears only when `Pass` is not
    Fail,
    /// Storyboard elements will appear when the player is winning
    ///
    /// Appears only when `Fail` is not
    Pass,
    /// Default layer
    Foreground,
    /// Storyboard elements will appear above the playfield
    ///
    /// Poorly documented but supported in osu!, trust me, it works
    Overlay,
}

impl fmt::Display for Layer {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Layer::Background => "Background",
                Layer::Fail => "Fail",
                Layer::Pass => "Pass",
                Layer::Foreground => "Foreground",
                Layer::Overlay => "Overlay",
            }
        )
    }
}

#[cfg(test)]
mod tests {
    use crate::Layer;

    #[test]
    fn origin() {
        assert_eq!(format!("{}", Layer::Background), "Background");
        assert_eq!(format!("{}", Layer::Fail), "Fail");
        assert_eq!(format!("{}", Layer::Pass), "Pass");
        assert_eq!(format!("{}", Layer::Foreground), "Foreground");
        assert_eq!(format!("{}", Layer::Overlay), "Overlay");
    }
}