Rose::Yaml Namespace Reference

Description

YAML parser and unparser.

Classes
class	ConstIterator
	Iterator over constant YAML nodes. More...
class	Exception
	Base class for YAML exceptions. More...
class	InternalException
	Internal exception. More...
class	Iterator
	Iterator over YAML nodes. More...
class	Node
	YAML node. More...
class	OperationException
	Operation exception. More...
class	ParsingException
	Parsing exception. More...
struct	SerializeConfig
	Serialization configuration structure, describing output behavior. More...

Functions
void	Parse (Node &root, const boost::filesystem::path &)
void	Parse (Node &root, std::iostream &)
void	Parse (Node &root, const std::string &data)
void	Parse (Node &root, const char *data, const size_t size)
void	parse (Node &root, const boost::filesystem::path &)
	Parse YAML from file into node.
void	parse (Node &root, std::iostream &)
	Parse YAML from stream into node.

Function Documentation

Serialize() [1/3]

void Rose::Yaml::Serialize	(	const Node &	root,
		const char *	filename,
		const SerializeConfig &	config = {2, 64, false, false}
	)

Serialize YAML.

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.
OperationException	If filename or buffer pointer is invalid. If config is invalid.

Serialize() [2/3]

void Rose::Yaml::Serialize	(	const Node &	root,
		std::iostream &	stream,
		const SerializeConfig &	config = {2, 64, false, false}
	)

Serialize YAML.

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.
OperationException	If filename or buffer pointer is invalid. If config is invalid.

Serialize() [3/3]

void Rose::Yaml::Serialize	(	const Node &	root,
		std::string &	string,
		const SerializeConfig &	config = {2, 64, false, false}
	)

Serialize YAML.

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.
OperationException	If filename or buffer pointer is invalid. If config is invalid.