📝 updated documentation for UBJSON functions

doc/examples/from_ubjson.cpp

@@ -0,0 +1,19 @@
+#include <iostream>
+#include "json.hpp"
+
+using json = nlohmann::json;
+
+int main()
+{
+    // create byte vector
+    std::vector<uint8_t> v = {0x7B, 0x69, 0x07, 0x63, 0x6F, 0x6D, 0x70, 0x61,
+                              0x63, 0x74, 0x54, 0x69, 0x06, 0x73, 0x63, 0x68,
+                              0x65, 0x6D, 0x61, 0x69, 0x00, 0x7D
+                             };
+
+    // deserialize it with UBJSON
+    json j = json::from_ubjson(v);
+
+    // print the deserialized JSON value
+    std::cout << std::setw(2) << j << std::endl;
+}

doc/examples/from_ubjson.link

@@ -0,0 +1 @@
+<a target="_blank" href="https://wandbox.org/permlink/sUHQtigs99PkzlID"><b>online</b></a>

doc/examples/from_ubjson.output

@@ -0,0 +1,4 @@
+{
+  "compact": true,
+  "schema": 0
+}

doc/examples/to_ubjson.cpp

@@ -0,0 +1,62 @@
+#include <iostream>
+#include "json.hpp"
+
+using json = nlohmann::json;
+
+// function to print UBJSON's diagnostic format
+void print_byte(uint8_t byte)
+{
+    if (32 < byte and byte < 128)
+    {
+        std::cout << (char)byte;
+    }
+    else
+    {
+        std::cout << (int)byte;
+    }
+}
+
+int main()
+{
+    // create a JSON value
+    json j = R"({"compact": true, "schema": false})"_json;
+
+    // serialize it to UBJSON
+    std::vector<uint8_t> v = json::to_ubjson(j);
+
+    // print the vector content
+    for (auto& byte : v)
+    {
+        print_byte(byte);
+    }
+    std::cout << std::endl;
+
+    // create an array of numbers
+    json array = {1, 2, 3, 4, 5, 6, 7, 8};
+
+    // serialize it to UBJSON using default representation
+    std::vector<uint8_t> v_array = json::to_ubjson(array);
+    // serialize it to UBJSON using size optimization
+    std::vector<uint8_t> v_array_size = json::to_ubjson(array, true);
+    // serialize it to UBJSON using type optimization
+    std::vector<uint8_t> v_array_size_and_type = json::to_ubjson(array, true, true);
+
+    // print the vector contents
+    for (auto& byte : v_array)
+    {
+        print_byte(byte);
+    }
+    std::cout << std::endl;
+
+    for (auto& byte : v_array_size)
+    {
+        print_byte(byte);
+    }
+    std::cout << std::endl;
+
+    for (auto& byte : v_array_size_and_type)
+    {
+        print_byte(byte);
+    }
+    std::cout << std::endl;
+}

doc/examples/to_ubjson.link

@@ -0,0 +1 @@
+<a target="_blank" href="https://wandbox.org/permlink/ibti7dSDi4xEPtzQ"><b>online</b></a>

doc/examples/to_ubjson.output

@@ -0,0 +1,4 @@
+{i7compactTi6schemaF}
+[i1i2i3i4i5i6i7i8]
+[#i8i1i2i3i4i5i6i7i8
+[$i#i812345678