Yaml Namespace Reference

Namespace wrapping mini-yaml classes. More...

Namespaces
	impl
	Helper classes and functions.

Classes
class	Exception
	Exception class. More...
class	InternalException
	Internal exception class. More...
class	ParsingException
	Parsing exception class. More...
class	OperationFatalException
	Operation exception class. More...
class	Iterator
	Iterator class. More...
class	ConstIterator
	Constant iterator class. More...
class	Node
	Node class. More...
struct	SerializeConfig
	Serialization configuration structure, describing output behavior. More...
class	TypeImp
class	SequenceImp
class	MapImp
class	ScalarImp
class	NodeImp
class	IteratorImp
class	SequenceIteratorImp
class	MapIteratorImp
class	SequenceConstIteratorImp
class	MapConstIteratorImp
class	ReaderLine
	Line information structure. More...
class	ParseImp
	Implementation class of Yaml parsing. Parsing incoming stream and outputs a root node. More...

Functions
void	Parse (Node &root, const char *filename)
	Parsing functions. Population given root node with deserialized data. More...
void	Parse (Node &root, std::iostream &stream)
void	Parse (Node &root, const std::string &string)
void	Parse (Node &root, const char *buffer, size_t size)
void	Serialize (Node const &root, char const *filename, SerializeConfig const &config)
	Serialization functions. More...
void	Serialize (Node const &root, std::iostream &stream, SerializeConfig const &config)
void	Serialize (Node const &root, std::string &string, SerializeConfig const &config)
bool	operator== (const ConstIterator &lhs, const ConstIterator &rhs)
bool	operator!= (const ConstIterator &lhs, const ConstIterator &rhs)
size_t	LineFolding (const std::string &input, std::vector< std::string > &folded, const size_t maxLength)

Variables
constexpr uint32_t	YAML_UNSPECIFIED_INTEGER = 32759
constexpr auto	g_ErrorInvalidCharacter = "Invalid character found."

Detailed Description

Namespace wrapping mini-yaml classes.

Adds NESStrongType overloads for the yaml library. This allows assignements of Yaml values with identifiers. This also directly enables Identifiers to be used within the Configuration classes, e.g. ScalarOption<WorkerId>

Function Documentation

LineFolding()

size_t Yaml::LineFolding	(	const std::string &	input,
		std::vector< std::string > &	folded,
		const size_t	maxLength
	)

operator!=()

bool Yaml::operator!=	(	const ConstIterator &	lhs,
		const ConstIterator &	rhs
	)

operator==()

bool Yaml::operator==	(	const ConstIterator &	lhs,
		const ConstIterator &	rhs
	)

Parse() [1/4]

void Yaml::Parse	(	Node &	root,
		const char *	buffer,
		size_t	size
	)

References Parse(), and size().

Here is the call graph for this function:

Parse() [2/4]

void Yaml::Parse	(	Node &	root,
		const char *	filename
	)

Parsing functions. Population given root node with deserialized data.

Parameters

root	Root node to populate.
filename	Path of input file.
stream	Input stream.
string	String of input data.
buffer	Char array of input data.
size	Buffer size.

Exceptions

InternalException	An internal error occurred.
ParsingException	Invalid input YAML data.
OperationFatalException	If filename or buffer pointer is invalid.

References data.

Referenced by Parse(), and NES::TEST_F().

Here is the caller graph for this function:

Parse() [3/4]

void Yaml::Parse	(	Node &	root,
		const std::string &	string
	)

References Parse().

Here is the call graph for this function:

Parse() [4/4]

void Yaml::Parse	(	Node &	root,
		std::iostream &	stream
	)

References Yaml::ParseImp::Parse().

Here is the call graph for this function:

Serialize() [1/3]

void Yaml::Serialize	(	Node const &	root,
		char const *	filename,
		SerializeConfig const &	config
	)

Serialization functions.

Parameters

root	Root node to serialize.
filename	Path of output file.
stream	Output stream.
string	String of output data.
config	Serialization configurations.

Exceptions

InternalException	An internal error occurred.
OperationFatalException	If filename or buffer pointer is invalid. If config is invalid.

Referenced by Serialize().

Here is the caller graph for this function:

Serialize() [2/3]

void Yaml::Serialize	(	Node const &	root,
		std::iostream &	stream,
		SerializeConfig const &	config
	)

References Yaml::SerializeConfig::SpaceIndentation.

Serialize() [3/3]

void Yaml::Serialize	(	Node const &	root,
		std::string &	string,
		SerializeConfig const &	config
	)

References Serialize().

Here is the call graph for this function:

Variable Documentation

g_ErrorInvalidCharacter

constexpr auto Yaml::g_ErrorInvalidCharacter = "Invalid character found."

inlineconstexpr

YAML_UNSPECIFIED_INTEGER

constexpr uint32_t Yaml::YAML_UNSPECIFIED_INTEGER = 32759

constexpr