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
98

use crate::{
    model::comments::{CommentBundle, CommentSort},
    request::{serialize::maybe_comment_sort, Query, Request},
    routing::Route,
    Osu,
};

use serde::Serialize;

/// Get a list of comments and their replies up to two levels deep in form of a
/// [`CommentBundle`].
#[must_use = "requests must be configured and executed"]
#[derive(Serialize)]
pub struct GetComments<'a> {
    #[serde(skip)]
    osu: &'a Osu,
    commentable_type: Option<String>,
    commentable_id: Option<u32>,
    parent_id: Option<u32>,
    #[serde(serialize_with = "maybe_comment_sort")]
    sort: Option<CommentSort>,
    #[serde(rename = "cursor_string")]
    cursor: Option<&'a str>,
}

impl<'a> GetComments<'a> {
    pub(crate) const fn new(osu: &'a Osu) -> Self {
        Self {
            osu,
            commentable_type: None,
            commentable_id: None,
            parent_id: None,
            sort: None,
            cursor: None,
        }
    }

    /// Sort the result by date, newest first
    #[inline]
    pub const fn sort_new(mut self) -> Self {
        self.sort = Some(CommentSort::New);

        self
    }

    /// Sort the result by vote count
    #[inline]
    pub const fn sort_top(mut self) -> Self {
        self.sort = Some(CommentSort::Top);

        self
    }

    /// Sort the result by date, oldest first
    #[inline]
    pub const fn sort_old(mut self) -> Self {
        self.sort = Some(CommentSort::Old);

        self
    }

    /// Limit to comments which are reply to the specified id. Specify 0 to get top level comments
    #[inline]
    pub const fn parent(mut self, parent_id: u32) -> Self {
        self.parent_id = Some(parent_id);

        self
    }

    /// The id of the resource to get comments for
    #[inline]
    pub const fn commentable_id(mut self, commentable_id: u32) -> Self {
        self.commentable_id = Some(commentable_id);

        self
    }

    /// The type of resource to get comments for
    #[inline]
    pub fn commentable_type(mut self, commentable_type: impl Into<String>) -> Self {
        self.commentable_type = Some(commentable_type.into());

        self
    }

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

        self
    }
}

into_future! {
    |self: GetComments<'_>| -> CommentBundle {
        Request::with_query(Route::GetComments, Query::encode(&self))
    }
}