pub unsafe fn yaml_emitter_dump(
emitter: *mut YamlEmitterT,
document: *mut YamlDocumentT,
) -> SuccessExpand description
Emit a YAML document.
The document object may be generated using the yaml_parser_load() function or the yaml_document_initialize() function. The emitter takes the responsibility for the document object and destroys its content after it is emitted. The document object is destroyed even if the function fails.
ยงSafety
emittermust be a valid, non-null pointer to a properly initializedYamlEmitterTstruct.documentmust be a valid, non-null pointer to aYamlDocumentTstruct that can be safely read from and will be destroyed by the function.- The
YamlEmitterTandYamlDocumentTstructs must be properly aligned and have the expected memory layout. - The
YamlEmitterTstruct must be in a valid state to emit the provided document.