rosu-v2 0.11.0

An osu! API v2 wrapper
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

use crate::{
    model::forum::ForumPosts,
    request::{Query, Request},
    routing::Route,
    Osu,
};

use serde::Serialize;

/// Get a [`ForumPosts`] struct for a forum topic
#[must_use = "requests must be configured and executed"]
#[derive(Serialize)]
pub struct GetForumPosts<'a> {
    #[serde(skip)]
    osu: &'a Osu,
    #[serde(skip)]
    topic_id: u64,
    sort: Option<&'static str>,
    limit: Option<usize>,
    start: Option<u64>,
    end: Option<u64>,
    #[serde(rename = "cursor_string")]
    cursor: Option<&'a str>,
}

impl<'a> GetForumPosts<'a> {
    pub(crate) const fn new(osu: &'a Osu, topic_id: u64) -> Self {
        Self {
            osu,
            topic_id,
            sort: None,
            limit: None,
            start: None,
            end: None,
            cursor: None,
        }
    }

    /// Maximum number of posts to be returned (20 default, 50 at most)
    #[inline]
    pub fn limit(mut self, limit: usize) -> Self {
        self.limit = Some(limit.min(50));

        self
    }

    /// Sort by ascending post ids. This is the default.
    #[inline]
    pub const fn sort_ascending(mut self) -> Self {
        self.sort = Some("id_asc");

        self
    }

    /// Sort by descending post ids
    #[inline]
    pub const fn sort_descending(mut self) -> Self {
        self.sort = Some("id_desc");

        self
    }

    /// First post id to be returned if sorted ascendingly.
    /// Parameter is ignored if `cursor` is specified.
    #[inline]
    pub const fn start_id(mut self, start: u64) -> Self {
        self.start = Some(start);

        self
    }

    /// First post id to be returned if sorted descendingly.
    /// Parameter is ignored if `cursor` is specified.
    #[inline]
    pub const fn end_id(mut self, end: u64) -> Self {
        self.end = Some(end);

        self
    }

    /// Specify a page by providing a cursor
    #[inline]
    pub const fn cursor(mut self, cursor: &'a str) -> Self {
        self.cursor = Some(cursor);

        self
    }
}

into_future! {
    |self: GetForumPosts<'_>| -> ForumPosts {
        Request::with_query(
            Route::GetForumPosts { topic_id: self.topic_id },
            Query::encode(&self),
        )
    }
}