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
|
use bytes::BufMut;
use http::Method;
use crate::{error::IntoHttpError, response::Response};
/// Trait for requests.
///
/// All requests in the API should implement this trait.
/// It provides a method to convert the request into an HTTP request.
///
/// The implementing type can perform any necessary validation on the request before converting it
/// into an HTTP request.
///
/// The [`Self::Response`] associated type is the type that should be used to represent the response
/// returned by the server.
pub trait Request: Sized + Clone {
type Response: Response;
/// The metadata for the request.
const METADATA: Metadata;
/// Tries to convert the request into an HTTP request.
///
/// On endpoints requiring authentication, the `token` field in `ctx` should be provided.
/// If not, the request will fail to convert.
///
/// # Arguments
///
/// * `ctx`: The context for the request.
///
/// # Errors
/// This function will return an error if the request cannot be converted into an HTTP request.
fn try_into_http_request<T: Default + BufMut>(
self,
ctx: Context,
) -> Result<http::Request<T>, IntoHttpError>;
}
/// Represents metadata for an API endpoint.
///
/// This struct holds information about the endpoint, such as the URL endpoint, HTTP method, and
/// authorization requirement.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Metadata {
/// The URL endpoint for the request.
pub endpoint: &'static str,
/// The HTTP method for the request.
pub method: Method,
/// Authorization requirement for the request.
pub auth: AuthRequirement,
}
/// Authorization requirement for an API request.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
pub enum AuthRequirement {
/// No authorization required.
#[default]
None,
/// Authorization is optional. Request may behave differently based on the presence of a token.
Optional,
/// Authorization is required. Request will fail if no token is provided.
Required,
}
/// Represents the universal context for an API request.
///
/// This struct contains the information needed to make an API request, such as the base URL,
/// client ID, and OAuth token if available.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct Context<'a> {
/// The base URL for the API.
pub base_url: &'a str,
/// The client ID for the API.
pub client_id: &'a str,
/// The OAuth token for the API, if requesting an authenticated endpoint.
pub oauth_token: Option<&'a str>,
}
|
