Struct libyml::yaml::YamlDocumentT

#[non_exhaustive]
#[repr(C)]
pub struct YamlDocumentT {
    pub nodes: YamlStackT<YamlNodeT>,
    pub version_directive: *mut YamlVersionDirectiveT,
    pub tag_directives: UnnamedYamlDocumentTTagDirectives,
    pub start_implicit: bool,
    pub end_implicit: bool,
    pub start_mark: YamlMarkT,
    pub end_mark: YamlMarkT,
}

The document structure.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

nodes: YamlStackT<YamlNodeT>

The document nodes.

version_directive: *mut YamlVersionDirectiveT

The version directive.

tag_directives: UnnamedYamlDocumentTTagDirectives

The list of tag directives.

start_implicit: bool

Is the document start indicator implicit?

end_implicit: bool

Is the document end indicator implicit?

start_mark: YamlMarkT

The beginning of the document.

end_mark: YamlMarkT

The end of the document.

Implementations

impl YamlDocumentT

pub unsafe fn cleanup(&mut self)

Cleans up resources used by YamlDocumentT. This includes deallocating memory for version directives, tag directives, and nodes if they were allocated dynamically.

Safety

This function is unsafe because it assumes that all pointers (e.g., version_directive, tag directives, and nodes) are either valid or null. It will attempt to free allocated memory, so the caller must ensure that:

1. The struct has been initialized properly.
2. No other code retains pointers to the data being freed here.
3. This method is not called concurrently with any operations that read from or write to the pointed-to data.
4. The memory management strategy (allocation and deallocation) is correctly paired. For instance, if libc::malloc is used to allocate, libc::free should be used to deallocate.

Trait Implementations

impl Clone for YamlDocumentT

fn clone(&self) -> YamlDocumentT

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for YamlDocumentT

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for YamlDocumentT

fn default() -> Self

Returns the “default value” for a type.