Emit from ConstNodeRef

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

Detailed Description

Function Documentation

emit_yaml() [1/2]

substr c4::yml::emit_yaml	(	ConstNodeRef const &	r,
		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

r	the starting node.
buf	the output buffer.
opts	emit options.
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 90 of file emit_buf.cpp.

{
    EmitterBuf em(opts, buf);
    em.emit_as(EMIT_YAML, r.tree(), r.id());
    return em.get_result(error_on_excess);
}

emit_yaml() [2/2]

substr c4::yml::emit_yaml	(	ConstNodeRef const &	r,
		substr	buf,
		bool	error_on_excess )

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

Definition at line 97 of file emit_buf.cpp.

{
    EmitterBuf em(EmitOptions{}, buf);
    em.emit_as(EMIT_YAML, r.tree(), r.id());
    return em.get_result(error_on_excess);
}

emit_json() [1/2]

substr c4::yml::emit_json	(	ConstNodeRef const &	r,
		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

r	the starting node.
buf	the output buffer.
opts	emit options.
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 104 of file emit_buf.cpp.

{
    EmitterBuf em(opts, buf);
    em.emit_as(EMIT_JSON, r.tree(), r.id());
    return em.get_result(error_on_excess);
}

emit_json() [2/2]

substr c4::yml::emit_json	(	ConstNodeRef const &	r,
		substr	buf,
		bool	error_on_excess )

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

Definition at line 111 of file emit_buf.cpp.

{
    EmitterBuf em(EmitOptions{}, buf);
    em.emit_as(EMIT_JSON, r.tree(), r.id());
    return em.get_result(error_on_excess);
}