aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/core/src/firebase/firestore/model/resource_path.h
diff options
context:
space:
mode:
authorGravatar Konstantin Varlamov <var-const@users.noreply.github.com>2018-02-06 19:15:54 -0500
committerGravatar GitHub <noreply@github.com>2018-02-06 19:15:54 -0500
commitb31fe35eb7a1301e1e6c5d3381b9f3d8054734dd (patch)
treeb21132267305b44c619a2ba1e30f03e4fad626be /Firestore/core/src/firebase/firestore/model/resource_path.h
parentaa0dba767e5757017057abc299fec0a87f313bfa (diff)
C++ port: port FSTFieldPath and FSTResourcePath to C++ (#749)
Similar to Objective-C, FieldPath and ResourcePath share most of their interface (and implementation) by deriving from BasePath (using CRTP, so that factory methods in BasePath can return an instance of the derived class).
Diffstat (limited to 'Firestore/core/src/firebase/firestore/model/resource_path.h')
-rw-r--r--Firestore/core/src/firebase/firestore/model/resource_path.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/Firestore/core/src/firebase/firestore/model/resource_path.h b/Firestore/core/src/firebase/firestore/model/resource_path.h
new file mode 100644
index 0000000..481d32f
--- /dev/null
+++ b/Firestore/core/src/firebase/firestore/model/resource_path.h
@@ -0,0 +1,84 @@
+/*
+ * 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_RESOURCE_PATH_H_
+#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_RESOURCE_PATH_H_
+
+#include <initializer_list>
+#include <string>
+
+#include "Firestore/core/src/firebase/firestore/model/base_path.h"
+#include "absl/strings/string_view.h"
+
+namespace firebase {
+namespace firestore {
+namespace model {
+
+/**
+ * A slash-separated path for navigating resources (documents and collections)
+ * within Firestore. Immutable; all instances are fully independent.
+ */
+class ResourcePath : public impl::BasePath<ResourcePath> {
+ public:
+ ResourcePath() = default;
+ /** Constructs the path from segments. */
+ template <typename IterT>
+ ResourcePath(const IterT begin, const IterT end) : BasePath{begin, end} {
+ }
+ ResourcePath(std::initializer_list<std::string> list) : BasePath{list} {
+ }
+ /**
+ * Creates and returns a new path from the given resource-path string, where
+ * the path segments are separated by a slash "/".
+ */
+ static ResourcePath Parse(absl::string_view path);
+
+ /** Returns a standardized string representation of this path. */
+ std::string CanonicalString() const;
+
+ bool operator==(const ResourcePath& rhs) const {
+ return BasePath::operator==(rhs);
+ }
+ bool operator!=(const ResourcePath& rhs) const {
+ return BasePath::operator!=(rhs);
+ }
+ bool operator<(const ResourcePath& rhs) const {
+ return BasePath::operator<(rhs);
+ }
+ bool operator>(const ResourcePath& rhs) const {
+ return BasePath::operator>(rhs);
+ }
+ bool operator<=(const ResourcePath& rhs) const {
+ return BasePath::operator<=(rhs);
+ }
+ bool operator>=(const ResourcePath& rhs) const {
+ return BasePath::operator>=(rhs);
+ }
+
+ private:
+ ResourcePath(SegmentsT&& segments) : BasePath{std::move(segments)} {
+ }
+
+ // So that methods of base can construct ResourcePath using the private
+ // constructor.
+ friend class BasePath;
+};
+
+} // namespace model
+} // namespace firestore
+} // namespace firebase
+
+#endif