restful 0.2.0

REST API helpers: validated Axum extractors, response envelopes, pagination, ordering, and field selection
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

/// Cursor pagination metadata included in list responses.
///
/// ```
/// use restful::pagination::cursor::CursorPaginationMetadata;
///
/// let meta = CursorPaginationMetadata::new(20, Some("abc".to_owned()));
/// assert!(meta.has_more);
///
/// let last_page = CursorPaginationMetadata::new(20, None);
/// assert!(!last_page.has_more);
/// ```
#[derive(Clone, Debug, serde::Serialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct CursorPaginationMetadata {
    /// Whether there are more items after this page.
    #[cfg_attr(feature = "utoipa", schema(example = true))]
    pub has_more: bool,
    /// Opaque cursor to pass as `?cursor=` for the next page.
    /// `None` when `hasMore` is `false`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_cursor: Option<String>,
    /// The limit that was applied to this request.
    #[cfg_attr(feature = "utoipa", schema(example = 20))]
    pub limit: u32,
}

impl CursorPaginationMetadata {
    /// Creates cursor pagination metadata.
    pub fn new(limit: u32, next_cursor: Option<String>) -> Self {
        Self {
            has_more: next_cursor.is_some(),
            next_cursor,
            limit,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn no_cursor_means_no_more() {
        let meta = CursorPaginationMetadata::new(20, None);
        assert!(!meta.has_more);
        assert!(meta.next_cursor.is_none());
        assert_eq!(meta.limit, 20);
    }

    #[test]
    fn some_cursor_means_has_more() {
        let meta = CursorPaginationMetadata::new(20, Some("opaque-token".to_string()));
        assert!(meta.has_more);
        assert_eq!(meta.next_cursor.as_deref(), Some("opaque-token"));
        assert_eq!(meta.limit, 20);
    }
}