summaryrefslogtreecommitdiff
path: root/mojo/public/cpp/bindings/map_traits.h
diff options
context:
space:
mode:
Diffstat (limited to 'mojo/public/cpp/bindings/map_traits.h')
-rw-r--r--mojo/public/cpp/bindings/map_traits.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/mojo/public/cpp/bindings/map_traits.h b/mojo/public/cpp/bindings/map_traits.h
new file mode 100644
index 0000000000..5c0d8b2846
--- /dev/null
+++ b/mojo/public/cpp/bindings/map_traits.h
@@ -0,0 +1,56 @@
+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef MOJO_PUBLIC_CPP_BINDINGS_MAP_TRAITS_H_
+#define MOJO_PUBLIC_CPP_BINDINGS_MAP_TRAITS_H_
+
+namespace mojo {
+
+// This must be specialized for any type |T| to be serialized/deserialized as
+// a mojom map.
+//
+// Usually you would like to do a partial specialization for a map template.
+// Imagine you want to specialize it for CustomMap<>, you need to implement:
+//
+// template <typename K, typename V>
+// struct MapTraits<CustomMap<K, V>> {
+// using Key = K;
+// using Value = V;
+//
+// // These two methods are optional. Please see comments in struct_traits.h
+// static bool IsNull(const CustomMap<K, V>& input);
+// static void SetToNull(CustomMap<K, V>* output);
+//
+// static size_t GetSize(const CustomMap<K, V>& input);
+//
+// static CustomConstIterator GetBegin(const CustomMap<K, V>& input);
+// static CustomIterator GetBegin(CustomMap<K, V>& input);
+//
+// static void AdvanceIterator(CustomConstIterator& iterator);
+// static void AdvanceIterator(CustomIterator& iterator);
+//
+// static const K& GetKey(CustomIterator& iterator);
+// static const K& GetKey(CustomConstIterator& iterator);
+//
+// static V& GetValue(CustomIterator& iterator);
+// static const V& GetValue(CustomConstIterator& iterator);
+//
+// // Returning false results in deserialization failure and causes the
+// // message pipe receiving it to be disconnected. |IK| and |IV| are
+// // separate input key/value template parameters that allows for the
+// // the key/value types to be forwarded.
+// template <typename IK, typename IV>
+// static bool Insert(CustomMap<K, V>& input,
+// IK&& key,
+// IV&& value);
+//
+// static void SetToEmpty(CustomMap<K, V>* output);
+// };
+//
+template <typename T>
+struct MapTraits;
+
+} // namespace mojo
+
+#endif // MOJO_PUBLIC_CPP_BINDINGS_MAP_TRAITS_H_