JSON value type. More...

#include <donut/json.hpp>

Inheritance diagram for donut::json::Value:

Public Member Functions
	Value () noexcept=default
	Construct a Null value.

	Value (Null) noexcept
	Construct a Null value.

	Value (std::nullptr_t) noexcept
	Construct a Null value.

	Value (Boolean value) noexcept
	Construct a Boolean value with the given underlying value.

	Value (const String &value)
	Construct a String value with the given underlying value.

	Value (String &&value) noexcept
	Construct a String value from the given underlying value.

	Value (const char *value)
	Construct a String value with the given underlying value.

	Value (std::string_view value)
	Construct a String value with the given underlying value.

	Value (const char8_t *value)
	Construct a String value with the given underlying value.

	Value (std::u8string_view value)
	Construct a String value with the given underlying value.

	Value (detail::number auto value) noexcept
	Construct a Number value with the given underlying value.

	Value (const Object &value)
	Construct an Object value with the given underlying value.

	Value (Object &&value) noexcept
	Construct an Object value from the given underlying value.

	Value (const Array &value)
	Construct an Array value with the given underlying value.

	Value (Array &&value) noexcept
	Construct an Array value from the given underlying value.

std::string	toString (const SerializationOptions &options={}) const
	Get a JSON string representation of the value.

bool	operator== (const Value &other) const
	Compare this value to another for equality.

std::partial_ordering	operator<=> (const Value &other) const
	Compare this value to another.

Public Member Functions inherited from donut::Variant< Null, Boolean, String, Number, Object, Array >
constexpr	Variant () noexcept(std::is_nothrow_default_constructible_v< variant_alternative_t< 0, Variant > >)
	Default-construct a variant with the first variant alternative, if it is default-constructible.

constexpr	Variant (U &&value) noexcept(std::is_nothrow_constructible_v< decltype(F(std::forward< U >(value)))>)
	Converting constructor.

constexpr	Variant (std::in_place_type_t< T > type, Args &&... args)
	Construct a variant alternative in-place given its type.

constexpr	Variant (std::in_place_type_t< T > type, std::initializer_list< U > ilist, Args &&... args)
	Construct a variant alternative in-place given its type, with an initializer list as the first constructor argument.

constexpr	Variant (std::in_place_index_t< Index > index, Args &&... args)
	Construct a variant alternative in-place given its index.

constexpr	Variant (std::in_place_index_t< Index > index, std::initializer_list< U > ilist, Args &&... args)
	Construct a variant alternative in-place given its index, with an initializer list as the first constructor argument.

constexpr	Variant (const Variant &other)=delete
	Deleted copy constructor.

constexpr	Variant (const Variant &other)=default
	Trivial copy constructor.

constexpr	Variant (const Variant &other)
	Copy constructor.

constexpr	Variant (Variant &&other) noexcept=default
	Trivial move constructor.

constexpr	Variant (Variant &&other) noexcept((std::is_nothrow_move_constructible_v< Ts > &&...))
	Move constructor.

constexpr	~Variant ()
	Destructor.

constexpr	~Variant ()=default
	Trivial destructor.

constexpr Variant &	operator= (const Variant &other)=delete
	Deleted copy assignment.

constexpr Variant &	operator= (const Variant &other)=default
	Trivial copy assignment.

constexpr Variant &	operator= (const Variant &other)
	Copy assignment.

constexpr Variant &	operator= (Variant &&other) noexcept=default
	Trivial move assignment.

constexpr Variant &	operator= (Variant &&other) noexcept(((std::is_nothrow_move_constructible_v< Ts > &&//NOLINT(performance-noexcept-move-constructor, cppcoreguidelines-noexcept-move-operations) std::is_nothrow_move_assignable_v< Ts >) &&...))
	Move assignment.

constexpr Variant &	operator= (U &&value) noexcept(std::is_nothrow_assignable_v< decltype(F(std::forward< U >(value)))&, U > &&std::is_nothrow_constructible_v< decltype(F(std::forward< U >(value))), U >)
	Converting assignment.

constexpr T &	emplace (Args &&... args)
	Construct an alternative given its type, destroying the old value.

constexpr T &	emplace (std::initializer_list< U > ilist, Args &&... args)
	Construct an alternative given its type, with an initializer list as the first constructor argument, destroying the old value.

constexpr variant_alternative_t< Index, Variant > &	emplace (Args &&... args)
	Construct an alternative given its index, destroying the old value.

constexpr variant_alternative_t< Index, Variant > &	emplace (std::initializer_list< U > ilist, Args &&... args)
	Construct an alternative given its index, with an initializer list as the first constructor argument, destroying the old value.

constexpr void	swap (Variant &other) noexcept(((std::is_nothrow_move_constructible_v< Ts > &&std::is_nothrow_swappable_v< Ts >) &&...))
	Swap this variant's value with that of another.

constexpr index_type	index () const noexcept
	Get the alternative index of the currently active value held by the variant.

constexpr bool	valueless_by_exception () const noexcept
	Check if the variant is in the valueless by exception state.

constexpr bool	is () const noexcept
	Check if the variant currently holds the alternative with the given type.

constexpr bool	is () const noexcept
	Check if the variant currently holds the alternative with the given index.

constexpr T &	as () &noexcept
	Access the underlying value with the given type without a safety check.

constexpr const T &	as () const &noexcept
	Access the underlying value with the given type without a safety check.

constexpr T &&	as () &&noexcept
	Access the underlying value with the given type without a safety check.

constexpr const T &&	as () const &&noexcept
	Access the underlying value with the given type without a safety check.

constexpr variant_alternative_t< Index, Variant > &	as () &noexcept
	Access the underlying value with the given index without a safety check.

constexpr const variant_alternative_t< Index, Variant > &	as () const &noexcept
	Access the underlying value with the given index without a safety check.

constexpr variant_alternative_t< Index, Variant > &&	as () &&noexcept
	Access the underlying value with the given index without a safety check.

constexpr const variant_alternative_t< Index, Variant > &&	as () const &&noexcept
	Access the underlying value with the given index without a safety check.

constexpr T &	get () &
	Access the underlying value with the given type.

constexpr const T &	get () const &
	Access the underlying value with the given type.

constexpr T &&	get () &&
	Access the underlying value with the given type.

constexpr const T &&	get () const &&
	Access the underlying value with the given type.

constexpr variant_alternative_t< Index, Variant > &	get () &
	Access the underlying value with the given index.

constexpr const variant_alternative_t< Index, Variant > &	get () const &
	Access the underlying value with the given index.

constexpr variant_alternative_t< Index, Variant > &&	get () &&
	Access the underlying value with the given index.

constexpr const variant_alternative_t< Index, Variant > &&	get () const &&
	Access the underlying value with the given index.

constexpr T *	get_if () noexcept
	Access the underlying value with the given type if it is the currently active alternative.

constexpr const T *	get_if () const noexcept
	Access the underlying value with the given type if it is the currently active alternative.

constexpr variant_alternative_t< Index, Variant > *	get_if () noexcept
	Access the underlying value with the given index if it is the currently active alternative.

constexpr const variant_alternative_t< Index, Variant > *	get_if () const noexcept
	Access the underlying value with the given index if it is the currently active alternative.

Static Public Member Functions
static Value	parse (std::u8string_view jsonString)
	Parse a value of any JSON type from a UTF-8 JSON string.

static Value	parse (std::string_view jsonString)
	Parse a value of any JSON type from a JSON string of bytes, interpreted as UTF-8.

Static Public Member Functions inherited from donut::Variant< Null, Boolean, String, Number, Object, Array >
static constexpr decltype(auto)	visit (Visitor &&visitor, V &&variant)
	Call a visitor functor with the currently active underlying value of a variant.

Additional Inherited Members
Public Types inherited from donut::Variant< Null, Boolean, String, Number, Object, Array >
using	index_type = std::conditional_t< sizeof...(Ts)< 255ull, std::uint8_t, std::conditional_t< sizeof...(Ts)< 65535ull, std::uint16_t, std::conditional_t< sizeof...(Ts)< 4294967295ull, std::uint32_t, std::uint64_t > > >
	Index type used to encode the active alternative type.

Static Public Attributes inherited from donut::Variant< Null, Boolean, String, Number, Object, Array >
static constexpr index_type	npos
	Invalid alternative index, representing the valueless by exception state.

Detailed Description

JSON value type.

Holds a value of one of the following types:

Null
Boolean
String
Number
Object
Array

Constructor & Destructor Documentation

◆ Value() [1/15]

donut::json::Value::Value ( )

defaultnoexcept

Construct a Null value.

◆ Value() [2/15]

donut::json::Value::Value ( Null )

inlinenoexcept

Construct a Null value.

◆ Value() [3/15]

donut::json::Value::Value ( std::nullptr_t )

inlinenoexcept

Construct a Null value.

◆ Value() [4/15]

donut::json::Value::Value ( Boolean value )

inlinenoexcept

Construct a Boolean value with the given underlying value.

Parameters

value value to copy.

◆ Value() [5/15]

donut::json::Value::Value ( const String & value )

inline

Construct a String value with the given underlying value.

Parameters

value value to copy.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [6/15]

donut::json::Value::Value ( String && value )

inlinenoexcept

Construct a String value from the given underlying value.

Parameters

value value to take.

◆ Value() [7/15]

donut::json::Value::Value ( const char * value )

inline

Construct a String value with the given underlying value.

Parameters

value read-only pointer to the null-terminated string to copy the contents of.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [8/15]

donut::json::Value::Value ( std::string_view value )

inline

Construct a String value with the given underlying value.

Parameters

value read-only view over the string to copy the contents of.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [9/15]

donut::json::Value::Value ( const char8_t * value )

inline

Construct a String value with the given underlying value.

Parameters

value read-only pointer to the null-terminated UTF-8 string to copy the contents of.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [10/15]

donut::json::Value::Value ( std::u8string_view value )

inline

Construct a String value with the given underlying value.

Parameters

value read-only view over the UTF-8 string to copy the contents of.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [11/15]

donut::json::Value::Value ( detail::number auto value )

inlinenoexcept

Construct a Number value with the given underlying value.

Parameters

value value to copy. May be of any fundamental arithmetic type except for bool and character types.

◆ Value() [12/15]

donut::json::Value::Value ( const Object & value )

inline

Construct an Object value with the given underlying value.

Parameters

value value to copy.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [13/15]

donut::json::Value::Value ( Object && value )

inlinenoexcept

Construct an Object value from the given underlying value.

Parameters

value value to take.

◆ Value() [14/15]

donut::json::Value::Value ( const Array & value )

inline

Construct an Array value with the given underlying value.

Parameters

value value to copy.

Exceptions

std::bad_alloc on allocation failure.

◆ Value() [15/15]

donut::json::Value::Value ( Array && value )

inlinenoexcept

Construct an Array value from the given underlying value.

Parameters

value value to take.

Member Function Documentation

◆ parse() [1/2]

Value donut::json::Value::parse ( std::u8string_view jsonString )

inlinestatic

Parse a value of any JSON type from a UTF-8 JSON string.

The parser supports JSON5 features such as comments, unquoted identifiers and trailing commas.

Parameters

jsonString read-only view over the JSON string to parse a value from.

Returns: the parsed value.

Exceptions

Error	on failure to parse a JSON value.
std::bad_alloc	on allocation failure.

◆ parse() [2/2]

Value donut::json::Value::parse ( std::string_view jsonString )

inlinestatic

Parse a value of any JSON type from a JSON string of bytes, interpreted as UTF-8.

The parser supports JSON5 features such as comments, unquoted identifiers and trailing commas.

Parameters

jsonString read-only view over the JSON string to parse a value from.

Returns: the parsed value.

Exceptions

Error	on failure to parse a JSON value.
std::bad_alloc	on allocation failure.

◆ toString()

std::string donut::json::Value::toString ( const SerializationOptions & options = {} ) const

inline

Get a JSON string representation of the value.

Parameters

options options for JSON serialization, see SerializationOptions.

Returns: a JSON string containing a representation of the value as it would be if it had been serialized to an output stream with the given options.

Exceptions

Error	on failure to serialize the value.
std::bad_alloc	on allocation failure.

◆ operator==()

bool donut::json::Value::operator== ( const Value & other ) const

inline

Compare this value to another for equality.

Parameters

other the value to compare this value to.

Returns: true if the values are equal, false otherwise.

◆ operator<=>()

std::partial_ordering donut::json::Value::operator<=> ( const Value & other ) const

inline

Compare this value to another.

Parameters

other the value to compare this value to.

Returns: a partial ordering between the two values.

The documentation for this class was generated from the following file:

include/donut/json.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Value() [1/15]

◆ Value() [2/15]

◆ Value() [3/15]

◆ Value() [4/15]

◆ Value() [5/15]

◆ Value() [6/15]

◆ Value() [7/15]

◆ Value() [8/15]

◆ Value() [9/15]

◆ Value() [10/15]

◆ Value() [11/15]

◆ Value() [12/15]

◆ Value() [13/15]

◆ Value() [14/15]

◆ Value() [15/15]

Member Function Documentation

◆ parse() [1/2]

◆ parse() [2/2]

◆ toString()

◆ operator==()

◆ operator<=>()