blob: 431e05ae55fefa6440ad6b4b6d83038e2790dc0c (
plain)
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
|
/*
* 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_FIELD_MASK_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_FIELD_MASK_H_
#include <initializer_list>
#include <string>
#include <utility>
#include <vector>
#include "Firestore/core/src/firebase/firestore/model/field_path.h"
#include "Firestore/core/src/firebase/firestore/util/hashing.h"
namespace firebase {
namespace firestore {
namespace model {
/**
* Provides a set of fields that can be used to partially patch a document.
* FieldMask is used in conjunction with FieldValue of Object type.
*
* Examples:
* foo - Overwrites foo entirely with the provided value. If foo is not
* present in the companion FieldValue, the field is deleted.
* foo.bar - Overwrites only the field bar of the object foo. If foo is not an
* object, foo is replaced with an object containing bar.
*/
class FieldMask {
public:
using const_iterator = std::vector<FieldPath>::const_iterator;
FieldMask(std::initializer_list<FieldPath> list) : fields_{list} {
}
explicit FieldMask(std::vector<FieldPath> fields)
: fields_{std::move(fields)} {
}
const_iterator begin() const {
return fields_.begin();
}
const_iterator end() const {
return fields_.end();
}
/**
* Verifies that `fieldPath` is included by at least one field in this field
* mask.
*
* This is an O(n) operation, where `n` is the size of the field mask.
*/
bool covers(const FieldPath& fieldPath) const {
for (const FieldPath& fieldMaskPath : fields_) {
if (fieldMaskPath.IsPrefixOf(fieldPath)) {
return true;
}
}
return false;
}
std::string ToString() const {
// Ideally, one should use a string builder. Since this is only non-critical
// code for logging and debugging, the logic is kept simple here.
std::string result("{ ");
for (const FieldPath& field : fields_) {
result += field.CanonicalString() + " ";
}
return result + "}";
}
#if defined(__OBJC__)
FieldMask() {
}
NSUInteger Hash() const {
return util::Hash(fields_);
}
#endif
friend bool operator==(const FieldMask& lhs, const FieldMask& rhs);
private:
std::vector<FieldPath> fields_;
};
inline bool operator==(const FieldMask& lhs, const FieldMask& rhs) {
return lhs.fields_ == rhs.fields_;
}
} // namespace model
} // namespace firestore
} // namespace firebase
#endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_FIELD_MASK_H_
|
