c4::yml::Emitter< Writer > Class Template Reference

A YAML/JSON emitter, templated on a writer class such as WriterBuf, WriterFile, or WriterOStream. More...

#include <emitter.hpp>

Inheritance diagram for c4::yml::Emitter< Writer >:

Public Member Functions
template<class... WriterArgs>
	Emitter (EmitOptions const &opts, WriterArgs &&...args) noexcept
	Construct the emitter and its internal Writer state. More...
void	emit_as (EmitType_e type, Tree const *tree, id_type id=NONE)
	emit! More...
EmitOptions const &	options () const noexcept
	get the emit options for this object More...

Detailed Description

template<class Writer>
class c4::yml::Emitter< Writer >

A YAML/JSON emitter, templated on a writer class such as WriterBuf, WriterFile, or WriterOStream.

Definition at line 34 of file emitter.hpp.

Constructor & Destructor Documentation

template<class Writer>

template<class... WriterArgs>

c4::yml::Emitter< Writer >::Emitter ( EmitOptions const &  opts, WriterArgs &&...  args  )

inlinenoexcept

Construct the emitter and its internal Writer state.

Parameters

opts	EmitOptions
args	arguments to be forwarded to the constructor of the writer.

Definition at line 44 of file emitter.hpp.

        : Writer(std::forward<WriterArgs>(args)...)
        , m_tree()
        , m_opts(opts)
        , m_col()
        , m_depth()
        , m_ilevel()
        , m_pws()
        , m_flow_pws()
    {}

Member Function Documentation

template<class Writer >

void c4::yml::Emitter< Writer >::emit_as	(	EmitType_e	type,
		Tree const *	tree,
		id_type	id = NONE
	)

emit!

Parameters

type	specify what to emit (YAML or JSON)
tree	the tree to emit
id	the id of the node to emit

Definition at line 48 of file emitter.def.hpp.

Referenced by c4::yml::emit_json(), c4::yml::emit_yaml(), and c4::yml::operator<<().

{
    RYML_ASSERT_BASIC_CB_(tree->callbacks(), !tree || !tree->empty() || id == NONE);
    if(!tree || tree->empty())
        return;
    if(id == NONE)
        id = tree->root_id();
    RYML_CHECK_VISIT_CB_(tree->callbacks(), id < tree->capacity(), tree, id);
    m_tree = tree;
    m_col = 0;
    m_depth = 0;
    m_ilevel = 0;
    m_pws = PWS_NONE_;
    m_flow_pws = {};
    if(type == EMIT_YAML)
        emit_yaml_(id);
    else if(type == EMIT_JSON)
        json_emit_(id);
    else
        RYML_ERR_BASIC_CB_(m_tree->callbacks(), "unknown emit type"); // LCOV_EXCL_LINE
    m_tree = nullptr;
}

template<class Writer>

EmitOptions const& c4::yml::Emitter< Writer >::options ( ) const

inlinenoexcept

get the emit options for this object

Definition at line 68 of file emitter.hpp.

{ return m_opts; }

---

The documentation for this class was generated from the following files:

• /tmp/B.egjz6vsx/BUILD/rapidyaml-0.16.0-build/rapidyaml-0.16.0/src/c4/yml/emitter.hpp
• /tmp/B.egjz6vsx/BUILD/rapidyaml-0.16.0-build/rapidyaml-0.16.0/src/c4/yml/emitter.def.hpp