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
|
/*
* 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_LOCAL_LOCAL_SERIALIZER_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_LOCAL_LOCAL_SERIALIZER_H_
#include <memory>
#include <vector>
#include "Firestore/core/src/firebase/firestore/model/document.h"
#include "Firestore/core/src/firebase/firestore/model/maybe_document.h"
#include "Firestore/core/src/firebase/firestore/model/no_document.h"
#include "Firestore/core/src/firebase/firestore/nanopb/reader.h"
#include "Firestore/core/src/firebase/firestore/nanopb/writer.h"
#include "Firestore/core/src/firebase/firestore/remote/serializer.h"
#include "Firestore/core/src/firebase/firestore/util/status.h"
namespace firebase {
namespace firestore {
namespace local {
/**
* @brief Serializer for values stored in the LocalStore.
*
* Note that local::LocalSerializer currently delegates to the
* remote::Serializer (for the Firestore v1beta1 RPC protocol) to save
* implementation time and code duplication. We'll need to revisit this when the
* RPC protocol we use diverges from local storage.
*/
class LocalSerializer {
public:
explicit LocalSerializer(const remote::Serializer& rpc_serializer)
: rpc_serializer_(rpc_serializer) {
}
/**
* @brief Encodes a MaybeDocument model to the equivalent bytes for local
* storage.
*
* @param maybe_doc the model to convert.
* @param[out] out_bytes A buffer to place the output. The bytes will be
* appended to this vector.
* @return A Status, which if not ok(), indicates what went wrong. Note that
* errors during encoding generally indicate a serious/fatal error.
*/
// TODO(rsgowman): If we never support any output except to a vector, it may
// make sense to have LocalSerializer own the vector and provide an accessor
// rather than asking the user to create it first.
util::Status EncodeMaybeDocument(const model::MaybeDocument& maybe_doc,
std::vector<uint8_t>* out_bytes) const;
/**
* @brief Decodes bytes representing a MaybeDocument proto to the equivalent
* model.
*
* @param bytes The bytes to convert. It's assumed that exactly all of the
* bytes will be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating what went
* wrong.
*/
util::StatusOr<std::unique_ptr<model::MaybeDocument>> DecodeMaybeDocument(
const uint8_t* bytes, size_t length) const;
/**
* @brief Decodes bytes representing a MaybeDocument proto to the equivalent
* model.
*
* @param bytes The bytes to convert. It's assumed that exactly all of the
* bytes will be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating what went
* wrong.
*/
util::StatusOr<std::unique_ptr<model::MaybeDocument>> DecodeMaybeDocument(
const std::vector<uint8_t>& bytes) const {
return DecodeMaybeDocument(bytes.data(), bytes.size());
}
private:
void EncodeMaybeDocument(nanopb::Writer* writer,
const model::MaybeDocument& maybe_doc) const;
std::unique_ptr<model::MaybeDocument> DecodeMaybeDocument(
nanopb::Reader* reader) const;
/**
* Encodes a Document for local storage. This differs from the v1beta1 RPC
* serializer for Documents in that it preserves the updateTime, which is
* considered an output only value by the server.
*/
void EncodeDocument(nanopb::Writer* writer, const model::Document& doc) const;
void EncodeNoDocument(nanopb::Writer* writer,
const model::NoDocument& no_doc) const;
std::unique_ptr<model::NoDocument> DecodeNoDocument(
nanopb::Reader* reader) const;
const remote::Serializer& rpc_serializer_;
};
} // namespace local
} // namespace firestore
} // namespace firebase
#endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_LOCAL_LOCAL_SERIALIZER_H_
|
