rosu-mods 0.4.1

Library for osu! mods
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

#![cfg(feature = "macros")]

/// Short-hand macro to easily create [`GameMods`] or [`GameModsIntermode`].
///
/// To create [`GameModsIntermode`], specify a space-separated list of
/// acronyms.
///
/// To create [`GameMods`], specify `Osu`, `Taiko`, `Catch`, or `Mania`,
/// followed by a colon (`:`), followed by a space-separated list of acronyms.
///
/// # Example
///
/// ```
/// # use rosu_mods::{mods, GameMods, GameModsIntermode};
/// let mods: GameMods = mods!(Taiko: NC HR);
/// assert_eq!(mods.to_string(), "HRNC");
///
/// let mods: GameModsIntermode = mods!(DT HR TC);
/// assert_eq!(mods.to_string(), "DTHRTC");
/// ```
///
/// [`GameMods`]: crate::GameMods
/// [`GameModsIntermode`]: crate::GameModsIntermode
#[macro_export(local_inner_macros)]
#[cfg_attr(all(docsrs, not(doctest)), doc(cfg(feature = "macros")))]
macro_rules! mods {
    ( Osu $( : $( $acronym:tt )* )? ) => {
        mods_inner!(@ Osu: $( $( $acronym )* )?)
    };
    ( Taiko $( : $( $acronym:tt )* )? ) => {
        mods_inner!(@ Taiko: $( $( $acronym )* )?)
    };
    ( Catch $( : $( $acronym:tt )* )? ) => {
        mods_inner!(@ Catch: $( $( $acronym )* )?)
    };
    ( Mania $( : $( $acronym:tt )* )? ) => {
        mods_inner!(@ Mania: $( $( $acronym )* )?)
    };
    ( $( $acronym:tt )* ) => {
        mods_inner!(@ $( $acronym )*)
    };
}

pub use pastey::paste;

#[cfg(test)]
mod tests {
    #[test]
    fn empty_intermode() {
        let mods = mods!();
        assert!(mods.is_empty());
    }

    #[test]
    fn single_intermode() {
        let mods = mods!(WG);
        assert_eq!(mods.len(), 1);
    }

    #[test]
    fn full_intermode() {
        let mods = mods!(HD DT DT HR TC);
        assert_eq!(mods.to_string(), "DTHDHRTC");
    }

    #[test]
    fn empty_catch() {
        let mods = mods!(Catch);
        assert!(mods.is_empty());
    }

    #[test]
    fn full_taiko() {
        let mods = mods!(Taiko: HR PF);
        assert_eq!(mods.len(), 2);
    }
}