-
Notifications
You must be signed in to change notification settings - Fork 4k
/
document_snapshot.dart
143 lines (114 loc) · 4.2 KB
/
document_snapshot.dart
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
// Copyright 2020, the Chromium project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
part of cloud_firestore;
typedef FromFirestore<T> = T Function(
DocumentSnapshot<Map<String, dynamic>> snapshot,
SnapshotOptions? options,
);
typedef ToFirestore<T> = Map<String, Object?> Function(
T value,
SetOptions? options,
);
/// Options that configure how data is retrieved from a DocumentSnapshot
/// (e.g. the desired behavior for server timestamps that have not yet been set to their final value).
///
/// Currently unsupported by FlutterFire, but exposed to avoid breaking changes
/// in the future once this class is supported.
@sealed
class SnapshotOptions {}
/// A [DocumentSnapshot] contains data read from a document in your [FirebaseFirestore]
/// database.
///
/// The data can be extracted with the data property or by using subscript
/// syntax to access a specific field.
@sealed
abstract class DocumentSnapshot<T extends Object?> {
/// This document's given ID for this snapshot.
String get id;
/// Returns the reference of this snapshot.
DocumentReference<T> get reference;
/// Metadata about this document concerning its source and if it has local
/// modifications.
SnapshotMetadata get metadata;
/// Returns `true` if the document exists.
bool get exists;
/// Contains all the data of this document snapshot.
T? data();
/// {@template firestore.documentsnapshot.get}
/// Gets a nested field by [String] or [FieldPath] from this [DocumentSnapshot].
///
/// Data can be accessed by providing a dot-notated path or [FieldPath]
/// which recursively finds the specified data. If no data could be found
/// at the specified path, a [StateError] will be thrown.
/// {@endtemplate}
dynamic get(Object field);
/// {@macro firestore.documentsnapshot.get}
dynamic operator [](Object field);
}
class _JsonDocumentSnapshot implements DocumentSnapshot<Map<String, dynamic>> {
_JsonDocumentSnapshot(this._firestore, this._delegate) {
DocumentSnapshotPlatform.verify(_delegate);
}
final FirebaseFirestore _firestore;
final DocumentSnapshotPlatform _delegate;
@override
String get id => _delegate.id;
@override
late final DocumentReference<Map<String, dynamic>> reference =
_firestore.doc(_delegate.reference.path);
@override
late final SnapshotMetadata metadata = SnapshotMetadata._(_delegate.metadata);
@override
bool get exists => _delegate.exists;
@override
Map<String, dynamic>? data() {
// TODO(rrousselGit): can we cache the result, to avoid deserializing it on every read?
return _CodecUtility.replaceDelegatesWithValueInMap(
_delegate.data(),
_firestore,
);
}
@override
dynamic get(Object field) {
return _CodecUtility.valueDecode(_delegate.get(field), _firestore);
}
@override
dynamic operator [](Object field) => get(field);
}
/// A [DocumentSnapshot] contains data read from a document in your [FirebaseFirestore]
/// database.
///
/// The data can be extracted with the data property or by using subscript
/// syntax to access a specific field.
class _WithConverterDocumentSnapshot<T> implements DocumentSnapshot<T> {
_WithConverterDocumentSnapshot(
this._originalDocumentSnapshot,
this._fromFirestore,
this._toFirestore,
);
final DocumentSnapshot<Map<String, dynamic>> _originalDocumentSnapshot;
final FromFirestore<T> _fromFirestore;
final ToFirestore<T> _toFirestore;
@override
T? data() {
if (!_originalDocumentSnapshot.exists) return null;
return _fromFirestore(_originalDocumentSnapshot, null);
}
@override
bool get exists => _originalDocumentSnapshot.exists;
@override
String get id => _originalDocumentSnapshot.id;
@override
SnapshotMetadata get metadata => _originalDocumentSnapshot.metadata;
@override
DocumentReference<T> get reference => _WithConverterDocumentReference<T>(
_originalDocumentSnapshot.reference,
_fromFirestore,
_toFirestore,
);
@override
dynamic get(Object field) => _originalDocumentSnapshot.get(field);
@override
dynamic operator [](Object field) => _originalDocumentSnapshot[field];
}