misskey-api 0.2.0

API bindings of Misskey, including requests/responses of endpoints and messages on channels
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

/// Paginated item type in [`PaginationRequest`].
pub trait PaginationItem {
    /// The ID type.
    type Id: Ord;
    /// Extracts an ID from the item.
    fn item_id(&self) -> Self::Id;
}

/// [`Request`][`misskey_core::Request`] that can be paginated via `since_id` and `until_id`.
pub trait PaginationRequest: misskey_core::Request {
    /// The paginated item type.
    type Item: PaginationItem;

    /// Sets the `since_id` field of the request.
    fn set_since_id(&mut self, since_id: <Self::Item as PaginationItem>::Id);
    /// Sets the `until_id` field of the request.
    fn set_until_id(&mut self, until_id: <Self::Item as PaginationItem>::Id);
    /// Sets the `limit` field of the request.
    fn set_limit(&mut self, limit: u8);
}

impl<R: ?Sized> PaginationRequest for &'_ mut R
where
    R: PaginationRequest,
{
    type Item = R::Item;

    fn set_since_id(&mut self, since_id: <Self::Item as PaginationItem>::Id) {
        R::set_since_id(self, since_id)
    }
    fn set_until_id(&mut self, until_id: <Self::Item as PaginationItem>::Id) {
        R::set_until_id(self, until_id)
    }
    fn set_limit(&mut self, limit: u8) {
        R::set_limit(self, limit)
    }
}

impl<R: ?Sized> PaginationRequest for Box<R>
where
    R: PaginationRequest,
{
    type Item = R::Item;

    fn set_since_id(&mut self, since_id: <Self::Item as PaginationItem>::Id) {
        R::set_since_id(self, since_id)
    }
    fn set_until_id(&mut self, until_id: <Self::Item as PaginationItem>::Id) {
        R::set_until_id(self, until_id)
    }
    fn set_limit(&mut self, limit: u8) {
        R::set_limit(self, limit)
    }
}

/// [`Request`][`misskey_core::Request`] that can be paginated via `offset`.
pub trait OffsetPaginationRequest: misskey_core::Request {
    /// The paginated item type.
    type Item;

    /// Sets the `offset` field of the request.
    fn set_offset(&mut self, offset: u64);
    /// Sets the `limit` field of the request.
    fn set_limit(&mut self, limit: u8);
}

impl<R: ?Sized> OffsetPaginationRequest for &'_ mut R
where
    R: OffsetPaginationRequest,
{
    type Item = R::Item;

    fn set_offset(&mut self, offset: u64) {
        R::set_offset(self, offset)
    }
    fn set_limit(&mut self, limit: u8) {
        R::set_limit(self, limit)
    }
}

impl<R: ?Sized> OffsetPaginationRequest for Box<R>
where
    R: OffsetPaginationRequest,
{
    type Item = R::Item;

    fn set_offset(&mut self, offset: u64) {
        R::set_offset(self, offset)
    }
    fn set_limit(&mut self, limit: u8) {
        R::set_limit(self, limit)
    }
}