Emit utilities

Utilities to emit YAML and JSON, either to a memory buffer or to a file or ostream-like class. More...

Topics
	Emit to file
	Emit to an STL-like ostream
	Emit to memory buffer
	Writer objects to use with an Emitter

Classes
class	c4::yml::Emitter< Writer >
	A stateful emitter, for use with a writer such as WriterBuf, WriterFile, or WriterOStream. More...
struct	c4::yml::EmitOptions
	A lightweight object containing options to be used when emitting. More...

Typedefs
template<class OStream>
using	c4::yml::EmitterOStream = Emitter<WriterOStream<OStream>>
using	c4::yml::EmitterFile = Emitter<WriterFile>
using	c4::yml::EmitterBuf = Emitter<WriterBuf>

Enumerations
enum	c4::yml::EmitType_e { c4::yml::EMIT_YAML = 0 , c4::yml::EMIT_JSON = 1 }
	Specifies the type of content to emit. More...

Detailed Description

Utilities to emit YAML and JSON, either to a memory buffer or to a file or ostream-like class.

See also

sample::sample_emit_to_container

sample::sample_emit_to_stream

sample::sample_emit_to_file

sample::sample_emit_nested_node

sample::sample_emit_style

Typedef Documentation

EmitterOStream

template<class OStream>

using c4::yml::EmitterOStream = Emitter<WriterOStream<OStream>>

Definition at line 38 of file emit.hpp.

EmitterFile

using c4::yml::EmitterFile = Emitter<WriterFile>

Definition at line 39 of file emit.hpp.

EmitterBuf

using c4::yml::EmitterBuf = Emitter<WriterBuf>

Definition at line 40 of file emit.hpp.

Enumeration Type Documentation

EmitType_e

enum c4::yml::EmitType_e

Specifies the type of content to emit.

Enumerator
EMIT_YAML	emit YAML
EMIT_JSON	emit JSON

Definition at line 48 of file emit.hpp.

             { // NOLINT
    EMIT_YAML = 0, ///< emit YAML
    EMIT_JSON = 1, ///< emit JSON
} EmitType_e;