rapidyaml  0.11.0
parse and emit YAML, and do it fast
Emit utilities

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

Modules

 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 = typedef Emitter<WriterOStream<OStream> >

Definition at line 37 of file emit.hpp.

◆ EmitterFile

Definition at line 38 of file emit.hpp.

◆ EmitterBuf

Definition at line 39 of file emit.hpp.

Enumeration Type Documentation

◆ EmitType_e

Specifies the type of content to emit.

Enumerator
EMIT_YAML 

emit YAML

EMIT_JSON 

emit JSON

Definition at line 47 of file emit.hpp.

47  {
48  EMIT_YAML = 0, ///< emit YAML
49  EMIT_JSON = 1, ///< emit JSON
50 } EmitType_e;
EmitType_e
Specifies the type of content to emit.
Definition: emit.hpp:47
@ EMIT_YAML
emit YAML
Definition: emit.hpp:48
@ EMIT_JSON
emit JSON
Definition: emit.hpp:49