firebase-wasm 0.8.1

Rust bindings for the Firebase v9 JS SDK.
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use wasm_bindgen::prelude::*;

use crate::FirebaseError;

#[derive(Clone, Copy, Debug, Default)]
#[wasm_bindgen(getter_with_clone)]
pub struct SetDocOptions {
    pub merge: Option<bool>,
}

#[wasm_bindgen(module = "firebase/firestore")]
extern "C" {
    #[derive(Clone, Debug)]
    pub type Firestore;
    #[derive(Clone, Debug)]
    pub type DocumentReference;
    #[derive(Clone, Debug)]
    pub type CollectionReference;
    #[derive(Clone, Debug)]
    pub type DocumentSnapshot;
    #[derive(Clone, Debug)]
    pub type Query;
    #[derive(Clone, Debug)]
    pub type QuerySnapshot;
    #[derive(Clone, Debug)]
    pub type QueryConstraint;
    #[derive(Clone, Debug)]
    pub type Transaction;

    #[wasm_bindgen(js_name = getFirestore)]
    pub fn get_firestore() -> Firestore;

    #[wasm_bindgen(catch)]
    pub fn doc(firestore: Firestore, path: &str) -> Result<DocumentReference, JsValue>;

    #[wasm_bindgen(js_name = getDoc, catch)]
    pub async fn get_doc(doc: DocumentReference) -> Result<JsValue, JsValue>;

    #[wasm_bindgen(js_name = getDocs, catch)]
    pub async fn get_docs(query: Query) -> Result<JsValue, JsValue>;

    #[wasm_bindgen(js_name = "setDoc", catch)]
    pub async fn set_doc(doc: DocumentReference, data: JsValue) -> Result<(), JsValue>;

    #[wasm_bindgen(js_name = "setDoc", catch)]
    pub async fn set_doc_with_options(
        doc: DocumentReference,
        data: JsValue,
        options: SetDocOptions,
    ) -> Result<(), JsValue>;

    #[wasm_bindgen(catch)]
    pub fn collection(
        firestore: Firestore,
        path: &str,
    ) -> Result<CollectionReference, FirebaseError>;

    #[wasm_bindgen(js_name = onSnapshot)]
    pub fn on_snapshot_doc(
        reference: DocumentReference,
        observer: &Closure<dyn FnMut(DocumentSnapshot)>,
    ) -> js_sys::Function;

    #[wasm_bindgen(js_name = onSnapshot)]
    pub fn on_snapshot_query(
        query: Query,
        observer: &Closure<dyn FnMut(QuerySnapshot)>,
    ) -> js_sys::Function;

    #[wasm_bindgen(variadic)]
    pub fn query(collection: CollectionReference, constraints: Vec<QueryConstraint>) -> Query;

    #[wasm_bindgen(js_name = "where")]
    pub fn where_(field_path: &str, op_str: &str, value: JsValue) -> QueryConstraint;

    #[wasm_bindgen(js_name = deleteDoc, catch)]
    pub async fn delete_doc(doc: DocumentReference) -> Result<(), JsValue>;

    #[wasm_bindgen(js_name = runTransaction, catch)]
    pub async fn run_transaction(
        firestore: Firestore,
        update_fn: &Closure<dyn FnMut(Transaction) -> js_sys::Promise>,
    ) -> Result<(), JsValue>;

    // =========================================================================
    //                            QuerySnapshot
    // =========================================================================

    #[wasm_bindgen(method, getter)]
    pub fn empty(this: &QuerySnapshot) -> bool;

    #[wasm_bindgen(method, getter)]
    pub fn size(this: &QuerySnapshot) -> usize;

    #[wasm_bindgen(method, getter)]
    pub fn docs(this: &QuerySnapshot) -> Vec<DocumentSnapshot>;

    // =========================================================================
    //                            DocumentSnapshot
    // =========================================================================

    #[wasm_bindgen(method)]
    pub fn exists(this: &DocumentSnapshot) -> bool;

    #[wasm_bindgen(method)]
    pub fn data(this: &DocumentSnapshot) -> JsValue;

    #[wasm_bindgen(method, getter)]
    pub fn id(this: &DocumentSnapshot) -> String;

    #[wasm_bindgen(method, js_name = "ref")]
    pub fn ref_(this: &DocumentSnapshot) -> DocumentReference;

    // =========================================================================
    //                            DocumentSnapshot
    // =========================================================================

    #[wasm_bindgen(method, catch, js_name = get)]
    pub(crate) async fn get_js(
        this: &Transaction,
        doc: DocumentReference,
    ) -> Result<JsValue, JsValue>;

    #[wasm_bindgen(method, js_name = set, catch)]
    pub(crate) fn set_js(
        this: &Transaction,
        doc: DocumentReference,
        data: JsValue,
    ) -> Result<Transaction, FirebaseError>;

    #[wasm_bindgen(method, js_name = update, catch)]
    pub(crate) fn update_js(
        this: &Transaction,
        doc: DocumentReference,
        data: JsValue,
    ) -> Result<Transaction, FirebaseError>;

    #[wasm_bindgen(method, js_name = delete, catch)]
    pub(crate) fn delete_js(
        this: &Transaction,
        doc: DocumentReference,
    ) -> Result<Transaction, FirebaseError>;
}