Update documentation and example with restricted BasicJsonType

kimci86 · kimci86 · commit 13d2d07a91b0 · 2025-01-18T16:52:00.000+01:00
diff --git a/docs/mkdocs/docs/api/macros/nlohmann_define_derived_type.md b/docs/mkdocs/docs/api/macros/nlohmann_define_derived_type.md
@@ -64,25 +64,25 @@ Summary:
 Macros 1 and 2 add two friend functions to the class which take care of the serialization and deserialization:
 
 ```cpp
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 friend void to_json(BasicJsonType&, const type&);
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 friend void from_json(const BasicJsonType&, type&);
 ```
 
 Macros 4 and 5 add two functions to the namespace which take care of the serialization and deserialization:
 
 ```cpp
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType&, const type&);
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void from_json(const BasicJsonType&, type&);
 ```
 
 Macros 3 and 6 add one function to the namespace which take care of the serialization only:
 
 ```cpp
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType&, const type&);
 ```
 
@@ -93,13 +93,13 @@ before serializing/deserializing the members of the derived type:
 class A { /* ... */ };
 class B : public A { /* ... */ };
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType& j, const B& b) {
     nlohmann::to_json(j, static_cast<const A&>(b));
     // ...
 }
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void from_json(const BasicJsonType& j, B& b) {
     nlohmann::from_json(j, static_cast<A&>(b));
     // ...
@@ -112,7 +112,7 @@ In the third case, only `to_json` will be called:
 class A { /* ... */ };
 class B : public A { /* ... */ };
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType& j, const B& b) {
     nlohmann::to_json(j, static_cast<const A&>(b));
     // ...
diff --git a/docs/mkdocs/docs/api/macros/nlohmann_define_type_intrusive.md b/docs/mkdocs/docs/api/macros/nlohmann_define_type_intrusive.md
@@ -40,9 +40,9 @@ Summary:
 The macros add two friend functions to the class which take care of the serialization and deserialization:
 
 ```cpp
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 friend void to_json(BasicJsonType&, const type&);
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 friend void from_json(const BasicJsonType&, type&); // except (3)
 ```
 
diff --git a/docs/mkdocs/docs/api/macros/nlohmann_define_type_non_intrusive.md b/docs/mkdocs/docs/api/macros/nlohmann_define_type_non_intrusive.md
@@ -40,9 +40,9 @@ Summary:
 The macros add two functions to the namespace which take care of the serialization and deserialization:
 
 ```cpp
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType&, const type&);
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void from_json(const BasicJsonType&, type&); // except (3)
 ```
 
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_explicit.cpp
@@ -19,15 +19,15 @@ class person
         : name(std::move(name_)), address(std::move(address_)), age(age_)
     {}
 
-    template<typename BasicJsonType>
+    template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
     friend void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
     {
         nlohmann_json_j["name"] = nlohmann_json_t.name;
         nlohmann_json_j["address"] = nlohmann_json_t.address;
         nlohmann_json_j["age"] = nlohmann_json_t.age;
     }
 
-    template<typename BasicJsonType>
+    template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
     friend void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)
     {
         nlohmann_json_t.name = nlohmann_json_j.at("name");
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_only_serialize_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_only_serialize_explicit.cpp
@@ -19,7 +19,7 @@ class person
         : name(std::move(name_)), address(std::move(address_)), age(age_)
     {}
 
-    template<typename BasicJsonType>
+    template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
     friend void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
     {
         nlohmann_json_j["name"] = nlohmann_json_t.name;
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_with_default_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_intrusive_with_default_explicit.cpp
@@ -19,15 +19,15 @@ class person
         : name(std::move(name_)), address(std::move(address_)), age(age_)
     {}
 
-    template<typename BasicJsonType>
+    template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
     friend void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
     {
         nlohmann_json_j["name"] = nlohmann_json_t.name;
         nlohmann_json_j["address"] = nlohmann_json_t.address;
         nlohmann_json_j["age"] = nlohmann_json_t.age;
     }
 
-    template<typename BasicJsonType>
+    template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
     friend void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)
     {
         person nlohmann_json_default_obj;
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_explicit.cpp
@@ -13,15 +13,15 @@ struct person
     int age;
 };
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
 {
     nlohmann_json_j["name"] = nlohmann_json_t.name;
     nlohmann_json_j["address"] = nlohmann_json_t.address;
     nlohmann_json_j["age"] = nlohmann_json_t.age;
 }
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)
 {
     nlohmann_json_t.name = nlohmann_json_j.at("name");
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_only_serialize_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_only_serialize_explicit.cpp
@@ -13,7 +13,7 @@ struct person
     int age;
 };
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
 {
     nlohmann_json_j["name"] = nlohmann_json_t.name;
diff --git a/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_with_default_explicit.cpp b/docs/mkdocs/docs/examples/nlohmann_define_type_non_intrusive_with_default_explicit.cpp
@@ -18,15 +18,15 @@ struct person
     {}
 };
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)
 {
     nlohmann_json_j["name"] = nlohmann_json_t.name;
     nlohmann_json_j["address"] = nlohmann_json_t.address;
     nlohmann_json_j["age"] = nlohmann_json_t.age;
 }
 
-template<typename BasicJsonType>
+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>
 void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)
 {
     person nlohmann_json_default_obj;

Original file line number	Diff line number	Diff line change
`@@ -19,15 +19,15 @@ class person`
`19`	`19`	`: name(std::move(name_)), address(std::move(address_)), age(age_)`
`20`	`20`	`{}`
`21`	`21`
`22`		`- template<typename BasicJsonType>`
	`22`	`+ template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`23`	`23`	`friend void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)`
`24`	`24`	`{`
`25`	`25`	`nlohmann_json_j["name"] = nlohmann_json_t.name;`
`26`	`26`	`nlohmann_json_j["address"] = nlohmann_json_t.address;`
`27`	`27`	`nlohmann_json_j["age"] = nlohmann_json_t.age;`
`28`	`28`	`}`
`29`	`29`
`30`		`- template<typename BasicJsonType>`
	`30`	`+ template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`31`	`31`	`friend void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)`
`32`	`32`	`{`
`33`	`33`	`nlohmann_json_t.name = nlohmann_json_j.at("name");`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class person`
`19`	`19`	`: name(std::move(name_)), address(std::move(address_)), age(age_)`
`20`	`20`	`{}`
`21`	`21`
`22`		`- template<typename BasicJsonType>`
	`22`	`+ template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`23`	`23`	`friend void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)`
`24`	`24`	`{`
`25`	`25`	`nlohmann_json_j["name"] = nlohmann_json_t.name;`
Original file line number	Diff line number	Diff line change
`@@ -13,15 +13,15 @@ struct person`
`13`	`13`	`int age;`
`14`	`14`	`};`
`15`	`15`
`16`		`-template<typename BasicJsonType>`
	`16`	`+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`17`	`17`	`void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)`
`18`	`18`	`{`
`19`	`19`	`nlohmann_json_j["name"] = nlohmann_json_t.name;`
`20`	`20`	`nlohmann_json_j["address"] = nlohmann_json_t.address;`
`21`	`21`	`nlohmann_json_j["age"] = nlohmann_json_t.age;`
`22`	`22`	`}`
`23`	`23`
`24`		`-template<typename BasicJsonType>`
	`24`	`+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`25`	`25`	`void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)`
`26`	`26`	`{`
`27`	`27`	`nlohmann_json_t.name = nlohmann_json_j.at("name");`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ struct person`
`13`	`13`	`int age;`
`14`	`14`	`};`
`15`	`15`
`16`		`-template<typename BasicJsonType>`
	`16`	`+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`17`	`17`	`void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)`
`18`	`18`	`{`
`19`	`19`	`nlohmann_json_j["name"] = nlohmann_json_t.name;`
Original file line number	Diff line number	Diff line change
`@@ -18,15 +18,15 @@ struct person`
`18`	`18`	`{}`
`19`	`19`	`};`
`20`	`20`
`21`		`-template<typename BasicJsonType>`
	`21`	`+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`22`	`22`	`void to_json(BasicJsonType& nlohmann_json_j, const person& nlohmann_json_t)`
`23`	`23`	`{`
`24`	`24`	`nlohmann_json_j["name"] = nlohmann_json_t.name;`
`25`	`25`	`nlohmann_json_j["address"] = nlohmann_json_t.address;`
`26`	`26`	`nlohmann_json_j["age"] = nlohmann_json_t.age;`
`27`	`27`	`}`
`28`	`28`
`29`		`-template<typename BasicJsonType>`
	`29`	`+template<typename BasicJsonType, nlohmann::detail::enable_if_t<nlohmann::detail::is_basic_json<BasicJsonType>::value, int> = 0>`
`30`	`30`	`void from_json(const BasicJsonType& nlohmann_json_j, person& nlohmann_json_t)`
`31`	`31`	`{`
`32`	`32`	`person nlohmann_json_default_obj;`