Replaced msgpack::unpacked with msgpack::object_handle.

msgpack::unpacked is a typedef of the msgpack::object_handle.
I recommend using msgpack::object_handle. It can be used not only
holding unpacked msgpack objects but also msgpack::objects that are
created by any types.

Replaced unpack() APIs in test codes and examples. They used to use old
APIs.

Author: redboltz

QUICKSTART-CPP.md

@@ -31,11 +31,11 @@ int main(void) {
         msgpack::pack(sbuf, vec);
 
         // deserialize it.
-        msgpack::unpacked msg;
-        msgpack::unpack(&msg, sbuf.data(), sbuf.size());
+        msgpack::object_handle oh =
+            msgpack::unpack(sbuf.data(), sbuf.size());
 
         // print the deserialized object.
-        msgpack::object obj = msg.get();
+        msgpack::object obj = oh.get();
         std::cout << obj << std::endl;  //=> ["Hello", "MessagePack"]
 
         // convert it into statically typed object.
@@ -79,9 +79,9 @@ int main(void) {
         pac.buffer_consumed(buffer.size());
 
         // now starts streaming deserialization.
-        msgpack::unpacked result;
-        while(pac.next(&result)) {
-            std::cout << result.get() << std::endl;
+        msgpack::object_handle oh;
+        while(pac.next(&oh)) {
+            std::cout << oh.get() << std::endl;
         }
 
         // results:
@@ -151,10 +151,10 @@ int main(void) {
         msgpack::sbuffer sbuf;
         msgpack::pack(sbuf, vec);
 
-        msgpack::unpacked msg;
-        msgpack::unpack(&msg, sbuf.data(), sbuf.size());
+        msgpack::object_handle oh =
+            msgpack::unpack(sbuf.data(), sbuf.size());
 
-        msgpack::object obj = msg.get();
+        msgpack::object obj = oh.get();
 
         // you can convert object to myclass directly
         std::vector<myclass> rvec;

README.md

@@ -83,12 +83,11 @@ int main(void)
     // deserialize the buffer into msgpack::object instance.
     std::string str(buffer.str());
 
-    msgpack::unpacked result;
+    msgpack::object_handle oh =
+        msgpack::unpack(str.data(), str.size());
 
-    msgpack::unpack(result, str.data(), str.size());
-
-    // deserialized object is valid during the msgpack::unpacked instance alive.
-    msgpack::object deserialized = result.get();
+    // deserialized object is valid during the msgpack::object_handle instance is alive.
+    msgpack::object deserialized = oh.get();
 
     // msgpack::object supports ostream.
     std::cout << deserialized << std::endl;

example/boost/msgpack_variant_capitalize.cpp

@@ -73,8 +73,8 @@ int main() {
     msgpack::pack(ss1, u);
     print(ss1.str());
 
-    msgpack::unpacked unp1 = msgpack::unpack(ss1.str().data(), ss1.str().size());
-    msgpack::object const& obj1 = unp1.get();
+    msgpack::object_handle oh1 = msgpack::unpack(ss1.str().data(), ss1.str().size());
+    msgpack::object const& obj1 = oh1.get();
     std::cout << "Unpacked msgpack object." << std::endl;
     std::cout << obj1 << std::endl;
 
@@ -87,8 +87,8 @@ int main() {
     msgpack::pack(ss2, v);
     print(ss2.str());
 
-    msgpack::unpacked unp2 = msgpack::unpack(ss2.str().data(), ss2.str().size());
-    msgpack::object const& obj2 = unp2.get();
+    msgpack::object_handle oh2 = msgpack::unpack(ss2.str().data(), ss2.str().size());
+    msgpack::object const& obj2 = oh2.get();
     std::cout << "Modified msgpack object." << std::endl;
     std::cout << obj2 << std::endl;
 }

example/boost/msgpack_variant_mapbased.cpp

@@ -79,8 +79,8 @@ int main() {
     u.address = "Tokyo";
     msgpack::pack(ss, u);
 
-    msgpack::unpacked unp = msgpack::unpack(ss.str().data(), ss.str().size());
-    msgpack::object const& obj = unp.get();
+    msgpack::object_handle oh = msgpack::unpack(ss.str().data(), ss.str().size());
+    msgpack::object const& obj = oh.get();
     std::cout << "Unpacked msgpack object." << std::endl;
     std::cout << obj << std::endl;
     msgpack::type::variant_ref v = obj.as<msgpack::type::variant_ref>();

example/cpp03/class_intrusive.cpp

@@ -84,9 +84,9 @@ int main() {
 
         print(ss.str());
 
-        msgpack::unpacked unp;
-        msgpack::unpack(unp, ss.str().data(), ss.str().size());
-        msgpack::object obj = unp.get();
+        msgpack::object_handle oh =
+            msgpack::unpack(ss.str().data(), ss.str().size());
+        msgpack::object obj = oh.get();
         std::cout << obj << std::endl;
         assert(obj.as<my_class>() == my);
     }

example/cpp03/class_intrusive_map.cpp

@@ -59,9 +59,9 @@ int main() {
 
         print(ss.str());
 
-        msgpack::unpacked unp;
-        msgpack::unpack(unp, ss.str().data(), ss.str().size());
-        msgpack::object obj = unp.get();
+        msgpack::object_handle oh =
+            msgpack::unpack(ss.str().data(), ss.str().size());
+        msgpack::object obj = oh.get();
         std::cout << obj << std::endl;
         assert(obj.as<my_class>() == my);
     }

example/cpp03/class_non_intrusive.cpp

@@ -102,9 +102,9 @@ int main() {
 
         print(ss.str());
 
-        msgpack::unpacked unp;
-        msgpack::unpack(unp, ss.str().data(), ss.str().size());
-        msgpack::object obj = unp.get();
+        msgpack::object_handle oh =
+            msgpack::unpack(ss.str().data(), ss.str().size());
+        msgpack::object obj = oh.get();
         std::cout << obj << std::endl;
         assert(obj.as<my_class>() == my);
     }

example/cpp03/custom.cpp

@@ -40,9 +40,9 @@ int main(void)
         std::stringstream sbuf;
         msgpack::pack(sbuf, oc);
 
-        msgpack::unpacked result;
-        msgpack::unpack(result, sbuf.str().data(), sbuf.str().size());
-        msgpack::object obj = result.get();
+        msgpack::object_handle oh =
+            msgpack::unpack(sbuf.str().data(), sbuf.str().size());
+        msgpack::object obj = oh.get();
 
         obj.convert(nc);
 
@@ -56,9 +56,9 @@ int main(void)
         std::stringstream sbuf;
         msgpack::pack(sbuf, nc);
 
-        msgpack::unpacked result;
-        msgpack::unpack(result, sbuf.str().data(), sbuf.str().size());
-        msgpack::object obj = result.get();
+        msgpack::object_handle oh =
+            msgpack::unpack(sbuf.str().data(), sbuf.str().size());
+        msgpack::object obj = oh.get();
 
         obj.convert(oc);
 

example/cpp03/enum.cpp

@@ -30,20 +30,20 @@ int main(void)
         my_enum e3 = elem3;
         msgpack::pack(sbuf, e3);
 
-        msgpack::unpacked result;
+        msgpack::object_handle oh;
         std::size_t off = 0;
 
-        msgpack::unpack(result, sbuf.str().data(), sbuf.str().size(), off);
-        std::cout << result.get().as<my_enum>() << std::endl;
-        assert(result.get().as<my_enum>() == elem1);
+        msgpack::unpack(oh, sbuf.str().data(), sbuf.str().size(), off);
+        std::cout << oh.get().as<my_enum>() << std::endl;
+        assert(oh.get().as<my_enum>() == elem1);
 
-        msgpack::unpack(result, sbuf.str().data(), sbuf.str().size(), off);
-        std::cout << result.get().as<my_enum>() << std::endl;
-        assert(result.get().as<my_enum>() == elem2);
+        msgpack::unpack(oh, sbuf.str().data(), sbuf.str().size(), off);
+        std::cout << oh.get().as<my_enum>() << std::endl;
+        assert(oh.get().as<my_enum>() == elem2);
 
-        msgpack::unpack(result, sbuf.str().data(), sbuf.str().size(), off);
-        std::cout << result.get().as<my_enum>() << std::endl;
-        assert(result.get().as<my_enum>() == elem3);
+        msgpack::unpack(oh, sbuf.str().data(), sbuf.str().size(), off);
+        std::cout << oh.get().as<my_enum>() << std::endl;
+        assert(oh.get().as<my_enum>() == elem3);
     }
     {   // create object without zone
         msgpack::object obj(elem2);

example/cpp03/map_based_versionup.cpp

@@ -71,9 +71,9 @@ int main() {
 
         print(ss.str());
 
-        msgpack::unpacked unp = msgpack::unpack(ss.str().data(), ss.str().size());
+        msgpack::object_handle oh = msgpack::unpack(ss.str().data(), ss.str().size());
 
-        msgpack::object obj = unp.get();
+        msgpack::object obj = oh.get();
         std::cout << obj << std::endl;
 
         v2 newv = obj.as<v2>();