Emit full tree

Functions
substr	c4::yml::emit_yaml (Tree const &t, EmitOptions const &opts, substr buf, bool error_on_excess=true)
	(1) emit YAML to the given buffer. More...
substr	c4::yml::emit_yaml (Tree const &t, substr buf, bool error_on_excess=true)
	(2) like (1), but use default emit options More...
substr	c4::yml::emit_json (Tree const &t, EmitOptions const &opts, substr buf, bool error_on_excess=true)
	(1) emit JSON to the given buffer. More...
substr	c4::yml::emit_json (Tree const &t, substr buf, bool error_on_excess=true)
	(2) like (1), but use default emit options More...

Detailed Description

Function Documentation

substr c4::yml::emit_yaml	(	Tree const &	t,
		EmitOptions const &	opts,
		substr	buf,
		bool	error_on_excess = true
	)

(1) emit YAML to the given buffer.

Return a substr trimmed to the emitted YAML.

Parameters

t	the tree; will be emitted from the root node.
opts	emit options.
buf	the output buffer.
error_on_excess	Raise an error if the space in the buffer is insufficient.

Returns

a substr trimmed to the result in the output buffer. If the buffer is insufficient (when error_on_excess is false), the string pointer of the result will be set to null, and the length will report the required buffer size. For example usage, see emitrs_yaml() .

Definition at line 28 of file emit_buf.cpp.

Referenced by c4::yml::emitrs_yaml(), sample_emit_to_container(), sample_emit_to_file(), sample_lightning_overview(), and sample_quick_overview().

{
    EmitterBuf em(opts, buf);
    em.emit_as(EMIT_YAML, &t);
    return em.get_result(error_on_excess);
}

substr c4::yml::emit_yaml	(	Tree const &	t,
		substr	buf,
		bool	error_on_excess
	)

(2) like (1), but use default emit options

Definition at line 35 of file emit_buf.cpp.

{
    EmitterBuf em(EmitOptions{}, buf);
    em.emit_as(EMIT_YAML, &t);
    return em.get_result(error_on_excess);
}

substr c4::yml::emit_json	(	Tree const &	t,
		EmitOptions const &	opts,
		substr	buf,
		bool	error_on_excess = true
	)

(1) emit JSON to the given buffer.

Return a substr trimmed to the emitted JSON.

Parameters

t	the tree; will be emitted from the root node.
opts	emit options.
buf	the output buffer.
error_on_excess	Raise an error if the space in the buffer is insufficient.

Returns

a substr trimmed to the result in the output buffer. If the buffer is insufficient (when error_on_excess is false), the string pointer of the result will be set to null, and the length will report the required buffer size.

Definition at line 42 of file emit_buf.cpp.

Referenced by c4::yml::emitrs_json().

{
    EmitterBuf em(opts, buf);
    em.emit_as(EMIT_JSON, &t);
    return em.get_result(error_on_excess);
}

substr c4::yml::emit_json	(	Tree const &	t,
		substr	buf,
		bool	error_on_excess
	)

(2) like (1), but use default emit options

Definition at line 49 of file emit_buf.cpp.

{
    EmitterBuf em(EmitOptions{}, buf);
    em.emit_as(EMIT_JSON, &t);
    return em.get_result(error_on_excess);
}