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
|
/*
* Copyright 2018 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_MAYBE_DOCUMENT_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_MAYBE_DOCUMENT_H_
#include <functional>
#include <memory>
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
namespace firebase {
namespace firestore {
namespace model {
/**
* The result of a lookup for a given path may be an existing document or a
* tombstone that marks the path deleted.
*/
class MaybeDocument {
public:
/**
* All the different kinds of documents, including MaybeDocument and its
* subclasses. This is used to provide RTTI for documents.
*/
enum class Type {
Unknown,
Document,
NoDocument,
};
MaybeDocument(DocumentKey key, SnapshotVersion version);
virtual ~MaybeDocument() {
}
/** The runtime type of this document. */
Type type() const {
return type_;
}
/** The key for this document. */
const DocumentKey& key() const {
return key_;
}
/**
* Returns the version of this document if it exists or a version at which
* this document was guaranteed to not exist.
*/
const SnapshotVersion& version() const {
return version_;
}
protected:
// Only allow subclass to set their types.
void set_type(Type type) {
type_ = type;
}
virtual bool Equals(const MaybeDocument& other) const;
friend bool operator==(const MaybeDocument& lhs, const MaybeDocument& rhs);
private:
Type type_ = Type::Unknown;
DocumentKey key_;
SnapshotVersion version_;
};
inline bool operator==(const MaybeDocument& lhs, const MaybeDocument& rhs) {
return lhs.Equals(rhs);
}
inline bool operator!=(const MaybeDocument& lhs, const MaybeDocument& rhs) {
return !(lhs == rhs);
}
/** Compares against another MaybeDocument by keys only. */
struct DocumentKeyComparator : public std::less<MaybeDocument> {
bool operator()(const MaybeDocument& lhs, const MaybeDocument& rhs) const {
return lhs.key() < rhs.key();
}
};
} // namespace model
} // namespace firestore
} // namespace firebase
#endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_MAYBE_DOCUMENT_H_
|
