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

//! Firestore Settings and Source types
//!
//! # C++ Reference
//! - `firestore/src/include/firebase/firestore/settings.h:49`
//! - `firestore/src/include/firebase/firestore/source.h:30`

/// Settings for configuring Firestore behavior
///
/// # C++ Reference
/// - `firestore/src/include/firebase/firestore/settings.h:49` - Settings class
///
/// Configure various Firestore settings including persistence, cache size, and network options.
#[derive(Debug, Clone)]
pub struct Settings {
    /// Host of the Firestore backend to connect to
    ///
    /// Default: "firestore.googleapis.com"
    pub host: String,

    /// Whether to use SSL for communication
    ///
    /// Default: true
    pub ssl_enabled: bool,

    /// Whether to enable local persistent storage
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/settings.h:120` - is_persistence_enabled()
    ///
    /// When enabled, Firestore caches documents locally and serves them when offline.
    ///
    /// Default: true
    pub persistence_enabled: bool,

    /// Cache size threshold for on-disk data in bytes
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/settings.h:123` - cache_size_bytes()
    ///
    /// If the cache grows beyond this size, Firestore will start removing data
    /// that hasn't been recently used. Set to -1 for unlimited cache.
    ///
    /// Default: 100 MB (104857600 bytes)
    pub cache_size_bytes: i64,

    /// Directory path for local cache storage
    ///
    /// If None, uses platform default:
    /// - macOS/Linux: `~/.firebase_cache/{project_id}/`
    /// - Windows: `%APPDATA%/firebase_cache/{project_id}/`
    /// - WASM: IndexedDB (not filesystem)
    pub cache_directory: Option<std::path::PathBuf>,
}

impl Default for Settings {
    fn default() -> Self {
        Self {
            host: "firestore.googleapis.com".to_string(),
            ssl_enabled: true,
            persistence_enabled: true,
            cache_size_bytes: 100 * 1024 * 1024, // 100 MB
            cache_directory: None,
        }
    }
}

impl Settings {
    /// Constant to use with cache_size_bytes to disable garbage collection
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/settings.h:57` - kCacheSizeUnlimited
    pub const CACHE_SIZE_UNLIMITED: i64 = -1;

    /// Creates default settings
    pub fn new() -> Self {
        Self::default()
    }
}

/// Source options for Firestore queries
///
/// # C++ Reference
/// - `firestore/src/include/firebase/firestore/source.h:30` - Source enum
///
/// Configures where Firestore should fetch data from.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Source {
    /// Default behavior - try server first, fall back to cache if offline
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/source.h:40` - kDefault
    Default,

    /// Only fetch from server, fail if offline
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/source.h:44` - kServer
    Server,

    /// Only fetch from local cache, fail if not cached
    ///
    /// # C++ Reference
    /// - `firestore/src/include/firebase/firestore/source.h:48` - kCache
    Cache,
}

impl Default for Source {
    fn default() -> Self {
        Source::Default
    }
}