speedrun-api 1.3.0

A wrapper for the speedrun.com REST API
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
99
100
101
102
103
104
105

//! # Platforms
//!
//! Endpoints available for platforms.
use std::{borrow::Cow, fmt::Display};

use serde::{Deserialize, Serialize};

use super::{endpoint::Endpoint, error::BodyError, query_params::QueryParams, Direction, Pageable};

/// Sorting options for platforms
#[derive(Debug, Serialize, Clone, Copy)]
#[serde(rename_all = "kebab-case")]
pub enum PlatformsSorting {
    /// Sorts alphanumerically by the platform name (default)
    Name,
    /// Sorts by the year the platform was released
    Released,
}

/// Represents a platform ID.
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Hash)]
pub struct PlatformId<'a>(Cow<'a, str>);

impl<'a> PlatformId<'a> {
    /// Create a new [`PlatformId`].
    pub fn new<T>(id: T) -> Self
    where
        T: Into<Cow<'a, str>>,
    {
        Self(id.into())
    }
}

impl<'a, T> From<T> for PlatformId<'a>
where
    T: Into<Cow<'a, str>>,
{
    fn from(value: T) -> Self {
        Self::new(value)
    }
}

impl Display for PlatformId<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", &self.0)
    }
}

/// Retrieves a list of all platforms.
#[derive(Default, Debug, Builder, Serialize, Clone)]
#[builder(default, setter(into, strip_option))]
#[serde(rename_all = "kebab-case")]
pub struct Platforms {
    #[doc = r"Sorting options for results."]
    orderby: Option<PlatformsSorting>,
    #[doc = r"Sort direction"]
    direction: Option<Direction>,
}

/// Retrieves a single platform by ID.
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "kebab-case")]
pub struct Platform<'a> {
    #[doc = r"`ID` of the platform to retrieve."]
    id: PlatformId<'a>,
}

impl Platforms {
    /// Create a builder for this endpoint.
    pub fn builder() -> PlatformsBuilder {
        PlatformsBuilder::default()
    }
}

impl Platform<'_> {
    /// Create a builder for this endpoint.
    pub fn builder<'a>() -> PlatformBuilder<'a> {
        PlatformBuilder::default()
    }
}

impl Default for PlatformsSorting {
    fn default() -> Self {
        Self::Name
    }
}

impl Endpoint for Platforms {
    fn endpoint(&self) -> std::borrow::Cow<'static, str> {
        "/platforms".into()
    }

    fn query_parameters(&self) -> Result<QueryParams<'_>, BodyError> {
        QueryParams::with(self)
    }
}

impl Endpoint for Platform<'_> {
    fn endpoint(&self) -> Cow<'static, str> {
        format!("/platforms/{}", self.id).into()
    }
}

impl Pageable for Platforms {}