Skip to main content

basaltic/
response.rs

1use crate::{Error, Result};
2use reqwest::header::HeaderMap;
3use serde::{Deserialize, Deserializer, Serialize, Serializer};
4
5/// A present nullable field. `Option<Nullable<T>>` distinguishes omission from null.
6#[derive(Clone, Debug, PartialEq)]
7pub enum Nullable<T> {
8    Null,
9    Value(T),
10}
11impl<T: Serialize> Serialize for Nullable<T> {
12    fn serialize<S: Serializer>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> {
13        match self {
14            Self::Null => serializer.serialize_none(),
15            Self::Value(v) => v.serialize(serializer),
16        }
17    }
18}
19impl<'de, T: Deserialize<'de>> Deserialize<'de> for Nullable<T> {
20    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> std::result::Result<Self, D::Error> {
21        Ok(Option::<T>::deserialize(deserializer)?
22            .map(Self::Value)
23            .unwrap_or(Self::Null))
24    }
25}
26/// Preserve explicit null for optional nullable fields during deserialization.
27pub(crate) fn present_nullable<'de, D, T>(
28    deserializer: D,
29) -> std::result::Result<Option<T>, D::Error>
30where
31    D: Deserializer<'de>,
32    T: Deserialize<'de>,
33{
34    T::deserialize(deserializer).map(Some)
35}
36
37#[derive(Clone, Debug)]
38pub struct ApiResponse<T> {
39    pub data: T,
40    pub status: u16,
41    pub headers: HeaderMap,
42}
43impl<T> ApiResponse<T> {
44    pub fn request_id(&self) -> &str {
45        self.headers
46            .get("x-request-id")
47            .and_then(|v| v.to_str().ok())
48            .unwrap_or("")
49    }
50    pub(crate) fn map<U>(self, data: U) -> ApiResponse<U> {
51        ApiResponse {
52            data,
53            status: self.status,
54            headers: self.headers,
55        }
56    }
57}
58
59#[derive(Clone, Debug)]
60pub struct Page<T, I> {
61    pub response: ApiResponse<T>,
62    pub items: Vec<I>,
63    pub has_more: bool,
64    pub marker: Option<String>,
65}
66impl<T, I> Page<T, I> {
67    pub fn request_id(&self) -> &str {
68        self.response.request_id()
69    }
70    pub(crate) fn next_marker(
71        &self,
72        seen: &mut std::collections::HashSet<String>,
73    ) -> Result<Option<String>> {
74        if !self.has_more {
75            return Ok(None);
76        }
77        match &self.marker {
78            Some(m) if !m.is_empty() && seen.insert(m.clone()) => Ok(Some(m.clone())),
79            _ => Err(Error::Protocol("Pagination did not advance".into())),
80        }
81    }
82}
83
84/// Prepared WebSocket URL and authentication headers. Connect with your chosen
85/// WebSocket library; keep the headers private and do not follow cross-host redirects.
86pub struct WebSocketConnection {
87    pub url: String,
88    pub headers: HeaderMap,
89}
90impl std::fmt::Debug for WebSocketConnection {
91    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
92        f.debug_struct("WebSocketConnection")
93            .finish_non_exhaustive()
94    }
95}