rosu-render 0.5.3

An o!rdr wrapper to render osu! replays
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

use std::fmt::{Display, Formatter, Result as FmtResult};

use hyper::Method;

use crate::client::RatelimiterKind;

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub(crate) enum Route {
    DynLink,
    Render,
    RenderList,
    ServerList,
    ServerOnlineCount,
    SkinList,
    SkinCustom,
    UserPreset,
}

impl Route {
    pub fn method(self) -> Method {
        match self {
            Self::Render => Method::POST,
            Self::DynLink
            | Self::RenderList
            | Self::ServerList
            | Self::ServerOnlineCount
            | Self::SkinList
            | Self::SkinCustom
            | Self::UserPreset => Method::GET,
        }
    }

    pub fn ratelimiter(self) -> RatelimiterKind {
        match self {
            Route::Render => RatelimiterKind::SendRender,
            Route::DynLink
            | Route::RenderList
            | Route::ServerList
            | Route::ServerOnlineCount
            | Route::SkinList
            | Route::SkinCustom
            | Route::UserPreset => RatelimiterKind::General,
        }
    }
}

impl Display for Route {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            // `dynlink` lives outside the `/ordr/` base path, so it is absolute
            // to the API host.
            Self::DynLink => f.write_str("/dynlink/ordr/gen"),
            Self::Render | Self::RenderList => f.write_str("renders"),
            Self::ServerList => f.write_str("servers"),
            Self::ServerOnlineCount => f.write_str("servers/onlinecount"),
            Self::SkinList => f.write_str("skins"),
            Self::SkinCustom => f.write_str("skins/custom"),
            Self::UserPreset => f.write_str("presets/bot"),
        }
    }
}

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

    #[test]
    fn endpoints() {
        for (route, path) in [
            (Route::DynLink, "/dynlink/ordr/gen"),
            (Route::Render, "renders"),
            (Route::RenderList, "renders"),
            (Route::ServerList, "servers"),
            (Route::ServerOnlineCount, "servers/onlinecount"),
            (Route::SkinList, "skins"),
            (Route::SkinCustom, "skins/custom"),
            (Route::UserPreset, "presets/bot"),
        ] {
            assert_eq!(route.to_string(), path);
            assert_eq!(
                route.method(),
                if route == Route::Render {
                    Method::POST
                } else {
                    Method::GET
                },
            );
            assert_eq!(
                route == Route::Render,
                matches!(route.ratelimiter(), RatelimiterKind::SendRender),
            );
        }
    }
}