firestore 0.61.1

Library provides a simple API for Google Firestore and own Serde serializer based on efficient gRPC 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
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Builder for specifying the ordering of Firestore query and listing results.
//!
//! This module provides a fluent API to define, per field, the direction results should be
//! sorted in.
//!
//! The main entry point is [`FirestoreQueryOrderBuilder`], passed into the closure given to
//! `.order()` on a select or listing builder.
//!
//! [`FirestoreQueryOrderBuilder`]: crate::select_order_builder::FirestoreQueryOrderBuilder

use crate::{FirestoreQueryDirection, FirestoreQueryOrder};

/// A builder for constructing a list of orderings to apply to a query or listing.
pub struct FirestoreQueryOrderBuilder {}

impl FirestoreQueryOrderBuilder {
    pub(crate) fn new() -> Self {
        Self {}
    }

    /// Collects `order_field_expr` - typically built with [`FirestoreQueryOrderBuilder::field`]
    /// and its chained methods - into the ordering for a query or listing, dropping `None`
    /// entries.
    #[inline]
    pub fn fields<I>(&self, order_field_expr: I) -> Vec<FirestoreQueryOrder>
    where
        I: IntoIterator,
        I::Item: FirestoreQueryOrderExpr,
    {
        order_field_expr
            .into_iter()
            .filter_map(|order| order.build_order())
            .collect()
    }

    /// Targets `field_name` for an ordering.
    #[inline]
    pub fn field<S>(&self, field_name: S) -> FirestoreQueryOrderFieldExpr
    where
        S: AsRef<str>,
    {
        FirestoreQueryOrderFieldExpr::new(field_name.as_ref().to_string())
    }
}

/// A trait for types that can be converted into a [`FirestoreQueryOrder`].
///
/// This is used by [`FirestoreQueryOrderBuilder::fields()`] to allow various ways of defining
/// orderings, including optional ones.
pub trait FirestoreQueryOrderExpr {
    /// Builds the [`FirestoreQueryOrder`].
    /// Returns `None` if the expression represents no ordering.
    fn build_order(self) -> Option<FirestoreQueryOrder>;
}

/// Represents a specific field targeted for an ordering.
///
/// This struct provides methods to define the direction to sort the field by.
pub struct FirestoreQueryOrderFieldExpr {
    field_name: String,
}

impl FirestoreQueryOrderFieldExpr {
    pub(crate) fn new(field_name: String) -> Self {
        Self { field_name }
    }

    /// Orders by this field ascending.
    /// Alias for [`ascending()`](#method.ascending).
    #[inline]
    pub fn asc(self) -> Option<FirestoreQueryOrder> {
        self.ascending()
    }

    /// Orders by this field descending.
    /// Alias for [`descending()`](#method.descending).
    #[inline]
    pub fn desc(self) -> Option<FirestoreQueryOrder> {
        self.descending()
    }

    /// Orders by this field ascending.
    #[inline]
    pub fn ascending(self) -> Option<FirestoreQueryOrder> {
        self.direction(FirestoreQueryDirection::Ascending)
    }

    /// Orders by this field descending.
    #[inline]
    pub fn descending(self) -> Option<FirestoreQueryOrder> {
        self.direction(FirestoreQueryDirection::Descending)
    }

    /// Orders by this field using a direction chosen at runtime.
    #[inline]
    pub fn direction(self, direction: FirestoreQueryDirection) -> Option<FirestoreQueryOrder> {
        Some(FirestoreQueryOrder::new(self.field_name, direction))
    }
}

impl FirestoreQueryOrderExpr for FirestoreQueryOrder {
    #[inline]
    fn build_order(self) -> Option<FirestoreQueryOrder> {
        Some(self)
    }
}

// Allows using Option<FirestoreQueryOrder> in the fields array,
// filtering out None values.
impl<F> FirestoreQueryOrderExpr for Option<F>
where
    F: FirestoreQueryOrderExpr,
{
    #[inline]
    fn build_order(self) -> Option<FirestoreQueryOrder> {
        self.and_then(|expr| expr.build_order())
    }
}