New

Author: d-frey

doc/ref/basic_value/get_array.md

@@ -0,0 +1,34 @@
+### `tao::json::basic_value::get_array`
+
+```c++
+array_t& get_array(); // (1)
+const array_t& get_array() const; // (2)
+array_t& unsafe_get_array(); // (3)
+const array_t& unsafe_get_array() const; // (4)
+```
+
+Get a reference to the embedded vector of nested `basic_string` values, with (1)&(2) or without (3)&(4) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. -
+3. `type() == json::type::ARRAY`
+4. `type() == json::type::ARRAY`
+
+#### Return value
+
+A const or non-const reference to the embedded `std::vector<basic_value>`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::ARRAY`
+2. `std::logic_error` if `type() != json::type::ARRAY`
+3. `noexcept`
+4. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_boolean.md

@@ -0,0 +1,28 @@
+### `tao::json::basic_value::get_boolean`
+
+```c++
+bool get_boolean() const; // (1)
+bool unsafe_get_boolean() const; // (2)
+```
+
+Access the embedded boolean, with (1) or without (2) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. `type() == json::type::BOOLEAN`
+
+#### Return value
+
+Returns the value of the embedded `bool`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::BOOLEAN`
+2. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_double.md

@@ -0,0 +1,28 @@
+### `tao::json::basic_value::get_double`
+
+```c++
+double get_double() const; // (1)
+double unsafe_get_double() const; // (2)
+```
+
+Access the embedded floating point value, with (1) or without (2) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. `type() == json::type::DOUBLE`
+
+#### Return value
+
+Returns the value of the embedded `double`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::DOUBLE`
+2. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_object.md

@@ -0,0 +1,34 @@
+### `tao::json::basic_value::get_object`
+
+```c++
+object_t& get_object(); // (1)
+const object_t& get_object() const; // (2)
+object_t& unsafe_get_object(); // (3)
+const object_t& unsafe_get_object() const; // (4)
+```
+
+Get a reference to the embedded map of nested `basic_string` values, with (1)&(2) or without (3)&(4) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. -
+3. `type() == json::type::OBJECT`
+4. `type() == json::type::OBJECT`
+
+#### Return value
+
+A const or non-const reference to the embedded `std::vector<basic_value>`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::OBJECT`
+2. `std::logic_error` if `type() != json::type::OBJECT`
+3. `noexcept`
+4. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_raw_ptr.md

@@ -0,0 +1,32 @@
+### `tao::json::basic_value::get_raw_ptr`
+
+```c++
+const basic_value* get_raw_ptr() const; // (1)
+const basic_value* unsafe_get_raw_ptr() const; // (2)
+```
+
+Access the embedded raw pointer, with (1) or without (2) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. `type() == json::type::RAW_PTR`
+
+#### Return value
+
+Returns the value of the embedded `const basic_value*`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::RAW_PTR`
+2. `noexcept`
+
+#### Complexity
+
+Constant
+
+#### Note
+
+The pointer itself can be the null pointer.

doc/ref/basic_value/get_signed.md

@@ -0,0 +1,28 @@
+### `tao::json::basic_value::get_signed`
+
+```c++
+std::int64_t get_signed() const; // (1)
+std::int64_t unsafe_get_signed() const; // (2)
+```
+
+Access the embedded integer, with (1) or without (2) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. `type() == json::type::SIGNED`
+
+#### Return value
+
+Returns the value of the embedded `std::int64_t`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::SIGNED`
+2. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_string.md

@@ -0,0 +1,34 @@
+### `tao::json::basic_value::get_string`
+
+```c++
+std::string& get_string(); // (1)
+const std::string& get_string() const; // (2)
+std::string& unsafe_get_string(); // (3)
+const std::string& unsafe_get_string() const; // (4)
+```
+
+Get a reference to the embedded string, with (1)&(2) or without (3)&(4) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. -
+3. `type() == json::type::STRING`
+4. `type() == json::type::STRING`
+
+#### Return value
+
+A const or non-const reference to the embedded `std::string`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::STRING`
+2. `std::logic_error` if `type() != json::type::STRING`
+3. `noexcept`
+4. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/get_unsigned.md

@@ -0,0 +1,28 @@
+### `tao::json::basic_value::get_unsigned`
+
+```c++
+std::uint64_t get_unsigned() const; // (1)
+std::uint64_t unsafe_get_unsigned() const; // (2)
+```
+
+Access the embedded integer, with (1) or without (2) checking the type first.
+
+#### Preconditions
+
+The instance must *not* be in a discarded state.
+
+1. -
+2. `type() == json::type::UNSIGNED`
+
+#### Return value
+
+Returns the value of the embedded `std::uint64_t`.
+
+#### Exceptions
+
+1. `std::logic_error` if `type() != json::type::UNSIGNED`
+2. `noexcept`
+
+#### Complexity
+
+Constant

doc/ref/basic_value/reset.md

@@ -0,0 +1,15 @@
+### `tao::json::basic_value::reset`
+
+```c++
+void reset() const; // (1)
+```
+
+Resets the instance. The destructors of the nested values (if any) are called and the used storage is deallocated. Note, that if the values are pointers (`type::RAW_PTR`), the pointed-to objects are not destroyed. The instance is then set into an uninitialized state.
+
+#### Exceptions
+
+1. `noexcept`
+
+#### Complexity
+
+1. Linear to the number of nodes destructed