blender::io::serialize Namespace Reference

Namespaces
namespace	json

Classes
class	PrimitiveValue
class	Value
class	NullValue
class	StringValue
class	ArrayValue
class	DictionaryValue
class	Formatter
class	JsonFormatter

Typedefs
using	IntValue = PrimitiveValue<int64_t, eValueType::Int>
using	DoubleValue = PrimitiveValue<double, eValueType::Double>
using	BooleanValue = PrimitiveValue<bool, eValueType::Boolean>
using	EnumValue = PrimitiveValue<int, eValueType::Enum>

Enumerations
enum class	eValueType {   String , Int , Array , Null ,   Boolean , Double , Dictionary , Enum }

Functions
void	write_json_file (StringRef path, const Value &value)
std::shared_ptr< Value >	read_json_file (StringRef path)
static void	convert_to_json (nlohmann::ordered_json &j, const Value &value)
static void	convert_to_json (nlohmann::ordered_json &j, const ArrayValue &value)
static void	convert_to_json (nlohmann::ordered_json &j, const DictionaryValue &value)
static std::unique_ptr< Value >	convert_from_json (const nlohmann::ordered_json &j)
static std::unique_ptr< ArrayValue >	convert_from_json_to_array (const nlohmann::ordered_json &j)
static std::unique_ptr< DictionaryValue >	convert_from_json_to_object (const nlohmann::ordered_json &j)

Typedef Documentation

BooleanValue

using blender::io::serialize::BooleanValue = PrimitiveValue<bool, eValueType::Boolean>

Definition at line 92 of file BLI_serialize.hh.

DoubleValue

using blender::io::serialize::DoubleValue = PrimitiveValue<double, eValueType::Double>

Definition at line 91 of file BLI_serialize.hh.

EnumValue

using blender::io::serialize::EnumValue = PrimitiveValue<int, eValueType::Enum>

Definition at line 93 of file BLI_serialize.hh.

IntValue

using blender::io::serialize::IntValue = PrimitiveValue<int64_t, eValueType::Int>

Definition at line 90 of file BLI_serialize.hh.

Enumeration Type Documentation

eValueType

enum class blender::io::serialize::eValueType

strong

Enumeration containing all sub-classes of Value. It is used as for type checking.

See also

#Value::type()

Enumerator
String
Int
Array
Null
Boolean
Double
Dictionary
Enum

Definition at line 75 of file BLI_serialize.hh.

Function Documentation

convert_from_json()

std::unique_ptr< Value > blender::io::serialize::convert_from_json ( const nlohmann::ordered_json & j )

static

Definition at line 164 of file serialize.cc.

References BLI_assert_unreachable, convert_from_json_to_array(), and convert_from_json_to_object().

Referenced by convert_from_json_to_array(), convert_from_json_to_object(), and blender::io::serialize::JsonFormatter::deserialize().

convert_from_json_to_array()

std::unique_ptr< ArrayValue > blender::io::serialize::convert_from_json_to_array ( const nlohmann::ordered_json & j )

static

Definition at line 145 of file serialize.cc.

References array< T, alignment >::append(), convert_from_json(), and element.

Referenced by convert_from_json().

convert_from_json_to_object()

std::unique_ptr< DictionaryValue > blender::io::serialize::convert_from_json_to_object ( const nlohmann::ordered_json & j )

static

Definition at line 154 of file serialize.cc.

References convert_from_json(), and element.

Referenced by convert_from_json().

convert_to_json() [1/3]

void blender::io::serialize::convert_to_json ( nlohmann::ordered_json & j, const ArrayValue & value )

static

Definition at line 73 of file serialize.cc.

References convert_to_json(), and blender::io::serialize::ArrayValue::elements().

convert_to_json() [2/3]

void blender::io::serialize::convert_to_json ( nlohmann::ordered_json & j, const DictionaryValue & value )

static

Definition at line 85 of file serialize.cc.

References convert_to_json(), and blender::io::serialize::DictionaryValue::elements().

convert_to_json() [3/3]

void blender::io::serialize::convert_to_json ( nlohmann::ordered_json & j, const Value & value )

static

Definition at line 97 of file serialize.cc.

References Array, blender::io::serialize::Value::as_array_value(), blender::io::serialize::Value::as_boolean_value(), blender::io::serialize::Value::as_dictionary_value(), blender::io::serialize::Value::as_double_value(), blender::io::serialize::Value::as_enum_value(), blender::io::serialize::Value::as_int_value(), blender::io::serialize::Value::as_string_value(), Boolean, convert_to_json(), Dictionary, Double, Enum, Int, Null, String, blender::io::serialize::Value::type(), blender::io::serialize::PrimitiveValue< T, V >::value(), and blender::io::serialize::StringValue::value().

Referenced by convert_to_json(), convert_to_json(), convert_to_json(), and blender::io::serialize::JsonFormatter::serialize().

read_json_file()

std::shared_ptr< Value > blender::io::serialize::read_json_file

(

StringRef

path

)

Definition at line 386 of file serialize.cc.

References blender::io::serialize::JsonFormatter::deserialize().

write_json_file()

void blender::io::serialize::write_json_file	(	StringRef	path,
		const Value &	value )

Definition at line 379 of file serialize.cc.

References blender::io::serialize::JsonFormatter::serialize().