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

use std::future::IntoFuture;

use bytes::Bytes;
use serde::de::DeserializeOwned;

use crate::{error::OsuError, model::ContainedUsers, request::Request, OsuResult};

/// Converting `Self` into an [`OsuFuture<Self>`].
///
/// [`OsuFuture<Self>`]: crate::future::OsuFuture
#[allow(
    private_bounds,
    reason = "users should not implement this trait anyway"
)]
pub trait OsuFutureData: IntoFuture<Output = OsuResult<Self::OsuOutput>> {
    /// The received [`Bytes`] will be turned into this type.
    type FromBytes: FromBytes;
    /// Post processing will convert [`Self::FromBytes`] into this type.
    type OsuOutput: ContainedUsers;
    /// Auxiliary data to create a request from a user.
    type FromUserData;
    /// Auxiliary data used for post processing.
    type PostProcessData;
}

/// Converting [`Bytes`] into `OsuResult<Self>`.
pub(crate) trait FromBytes: Sized {
    fn from_bytes(bytes: Bytes) -> OsuResult<Self>;
}

/// [`Bytes`] wrapper to implement [`FromBytes`] for bytes.
#[doc(hidden)]
pub struct BytesWrap(pub(crate) Bytes);

impl FromBytes for BytesWrap {
    fn from_bytes(bytes: Bytes) -> OsuResult<Self> {
        Ok(Self(bytes))
    }
}

impl<T: DeserializeOwned> FromBytes for T {
    fn from_bytes(bytes: Bytes) -> OsuResult<Self> {
        serde_json::from_slice(&bytes).map_err(|source| OsuError::Parsing { bytes, source })
    }
}

/// Auxiliary trait to simplify logic within the [`into_future!`] macro.
pub(crate) trait IntoPostProcessData<D> {
    fn into_data(self) -> (Request, D);
}

impl IntoPostProcessData<()> for Request {
    fn into_data(self) -> (Request, ()) {
        (self, ())
    }
}

impl<D> IntoPostProcessData<D> for (Request, D) {
    fn into_data(self) -> (Request, D) {
        self
    }
}