Function libyml::document::yaml_document_start_event_initialize
source · pub unsafe fn yaml_document_start_event_initialize(
event: *mut YamlEventT,
version_directive: *mut YamlVersionDirectiveT,
tag_directives_start: *mut YamlTagDirectiveT,
tag_directives_end: *mut YamlTagDirectiveT,
implicit: bool,
) -> Success
Expand description
Create the DOCUMENT-START event.
The implicit
argument is considered as a stylistic parameter and may be
ignored by the emitter.
§Safety
event
must be a valid, non-null pointer to aYamlEventT
struct that can be safely written to.version_directive
, if not null, must point to a validYamlVersionDirectiveT
struct.tag_directives_start
andtag_directives_end
must be valid pointers toYamlTagDirectiveT
structs, or both must be null.- If
tag_directives_start
andtag_directives_end
are not null, the range they define must contain validYamlTagDirectiveT
structs with non-nullhandle
andprefix
members, and thehandle
andprefix
strings must be valid UTF-8. - The
YamlEventT
,YamlVersionDirectiveT
, andYamlTagDirectiveT
structs must be properly aligned and have the expected memory layout. - The caller is responsible for freeing any dynamically allocated memory associated with the event using
yaml_event_delete
.