speedrun_api/api/
engines.rs

1//! # Engines
2//!
3//! Endpoints relating to engines.
4
5use std::{borrow::Cow, fmt::Display};
6
7use serde::{Deserialize, Serialize};
8
9use super::{endpoint::Endpoint, error::BodyError, query_params::QueryParams, Direction, Pageable};
10
11/// Sorting options for engines
12#[derive(Debug, Serialize, Clone, Copy)]
13#[serde(rename_all = "kebab-case")]
14pub enum EnginesSorting {
15    /// Sort alphanumerically by engine name (default)
16    Name,
17}
18
19/// Represents an engine ID.
20#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq, Hash)]
21pub struct EngineId<'a>(Cow<'a, str>);
22
23impl<'a> EngineId<'a> {
24    /// Create a new [`EngineId`]
25    pub fn new<T>(id: T) -> Self
26    where
27        T: Into<Cow<'a, str>>,
28    {
29        Self(id.into())
30    }
31}
32
33impl<'a, T> From<T> for EngineId<'a>
34where
35    T: Into<Cow<'a, str>>,
36{
37    fn from(value: T) -> Self {
38        Self::new(value)
39    }
40}
41
42impl Display for EngineId<'_> {
43    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
44        write!(f, "{}", &self.0)
45    }
46}
47
48/// Retrieves a list of engines.
49#[derive(Default, Debug, Builder, Serialize, Clone)]
50#[builder(default, setter(into, strip_option))]
51#[serde(rename_all = "kebab-case")]
52pub struct Engines {
53    #[doc = r"Sorting options for engines"]
54    orderby: Option<EnginesSorting>,
55    #[doc = r"Sort direction"]
56    direction: Option<Direction>,
57}
58
59/// Retrieves a single engine represented by `ID`.
60#[derive(Debug, Builder, Clone)]
61#[builder(setter(into, strip_option))]
62pub struct Engine<'a> {
63    #[doc = r"`ID` of the engine"]
64    id: EngineId<'a>,
65}
66
67impl Engines {
68    /// Create a builder for this endpoint.
69    pub fn builder() -> EnginesBuilder {
70        EnginesBuilder::default()
71    }
72}
73
74impl Engine<'_> {
75    /// Create a builder for this endpoint.
76    pub fn builder<'a>() -> EngineBuilder<'a> {
77        EngineBuilder::default()
78    }
79}
80
81impl Default for EnginesSorting {
82    fn default() -> Self {
83        Self::Name
84    }
85}
86
87impl Endpoint for Engines {
88    fn endpoint(&self) -> Cow<'static, str> {
89        "/engines".into()
90    }
91
92    fn query_parameters(&self) -> Result<QueryParams<'_>, BodyError> {
93        QueryParams::with(self)
94    }
95}
96
97impl Endpoint for Engine<'_> {
98    fn endpoint(&self) -> Cow<'static, str> {
99        format!("/engines/{}", self.id).into()
100    }
101}
102
103impl Pageable for Engines {}
speedrun_api/api/engines.rs

speedrun_api/api/
engines.rs
