firebase-rust-sdk 0.1.0-beta

Unofficial Rust port of Firebase C++ SDK
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

//! Firestore DocumentSnapshot and SnapshotMetadata types
//!
//! # C++ Reference
//! - `firestore/src/include/firebase/firestore/document_snapshot.h:58`
//! - `firestore/src/include/firebase/firestore/snapshot_metadata.h:35`

use super::document_reference::DocumentReference;
use super::field_value::{MapValue, Value};

/// Firestore document snapshot
///
/// # C++ Reference
/// - `firestore/src/include/firebase/firestore/document_snapshot.h:58`
#[derive(Debug, Clone)]
pub struct DocumentSnapshot {
    /// Document reference
    pub reference: DocumentReference,

    /// Document data (None if document doesn't exist)
    /// Contains protobuf MapValue
    /// 
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/document_snapshot.h:186` - GetData() returns MapValue
    pub data: Option<MapValue>,

    /// Document metadata
    pub metadata: SnapshotMetadata,
}

impl DocumentSnapshot {
    /// Check if document exists
    /// 
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/document_snapshot.h:172`
    pub fn exists(&self) -> bool {
        self.data.is_some()
    }

    /// Get a field value by path
    /// 
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/document_snapshot.h:196`
    pub fn get(&self, field: &str) -> Option<&Value> {
        let Some(data) = &self.data else {
            return None;
        };
        data.fields.get(field)
    }

    /// Get document ID
    pub fn id(&self) -> &str {
        self.reference.id()
    }
}

/// Metadata about a document snapshot
///
/// # C++ Reference
/// - `firestore/src/include/firebase/firestore/snapshot_metadata.h:35`
#[derive(Debug, Clone, Copy)]
pub struct SnapshotMetadata {
    /// Whether the snapshot contains pending writes
    pub has_pending_writes: bool,

    /// Whether the data came from cache
    pub is_from_cache: bool,
}

impl Default for SnapshotMetadata {
    fn default() -> Self {
        Self {
            has_pending_writes: false,
            is_from_cache: false,
        }
    }
}

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

    #[test]
    fn test_document_snapshot_metadata_default() {
        let metadata = SnapshotMetadata::default();
        assert!(!metadata.has_pending_writes);
        assert!(!metadata.is_from_cache);
    }

    #[test]
    fn test_document_snapshot_metadata_pending_writes() {
        let metadata = SnapshotMetadata {
            has_pending_writes: true,
            is_from_cache: false,
        };
        assert!(metadata.has_pending_writes);
    }

    #[test]
    fn test_document_snapshot_metadata_from_cache() {
        let metadata = SnapshotMetadata {
            has_pending_writes: false,
            is_from_cache: true,
        };
        assert!(metadata.is_from_cache);
    }

    #[test]
    fn test_document_snapshot_metadata_all_flags() {
        let metadata = SnapshotMetadata {
            has_pending_writes: true,
            is_from_cache: true,
        };
        assert!(metadata.has_pending_writes);
        assert!(metadata.is_from_cache);
    }
}