A lightweight object containing options to be used when emitting. More...

#include <emit.hpp>

Public Member Functions
bool	operator== (const EmitOptions &that) const noexcept
option flags - control emission of non-root (nested) nodes
EmitOptions &	emit_nonroot_key (bool enabled) noexcept
	When emit starts on a node which is not the root node, emit the node key as well.
bool	emit_nonroot_key () const noexcept
EmitOptions &	emit_nonroot_dash (bool enabled) noexcept
	When emit starts on a node which is not the root node, emit a leading dash.
bool	emit_nonroot_dash () const noexcept
option flags - json behavior
EmitOptions &	json_err_on_stream (bool enabled) noexcept
	Whether to trigger an error when findind a stream in json mode.
bool	json_err_on_stream () const noexcept
EmitOptions &	json_err_on_tag (bool enabled) noexcept
	Whether to trigger an error (or ignore the tag) when finding a tag in json mode.
bool	json_err_on_tag () const noexcept
EmitOptions &	json_err_on_anchor (bool enabled) noexcept
	Whether to trigger an error (or ignore the anchor) when finding an anchor in json mode.
bool	json_err_on_anchor () const noexcept

flow customization
static constexpr const id_type	max_cols_default = 80
bool	indent_flow_ml () const noexcept
	Indent the contents of FLOW_ML1 and FLOW_MLN containers.
EmitOptions &	indent_flow_ml (bool enabled) noexcept
EmitOptions &	force_flow_spc (bool enabled) noexcept
	Force everywhere a space after comma in flow mode, overriding the FLOW_SPC status of individual containers.
bool	force_flow_spc () const noexcept
EmitOptions &	max_cols (id_type cols) noexcept
	Set max columns for the emitted YAML in FLOW_MLN mode.
id_type	max_cols () const noexcept

maximum depth for the emitted tree
This prevents stack overflows by making the emitter fail when the tree exceeds the maximum depth.
static constexpr const id_type	max_depth_default = 64
id_type	max_depth () const noexcept
EmitOptions &	max_depth (id_type d) noexcept

Detailed Description

A lightweight object containing options to be used when emitting.

Definition at line 59 of file emit.hpp.

The documentation for this struct was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.15.1/src/c4/yml/emit.hpp

Public Member Functions