Struct MetadataWriteOptions 

pub struct MetadataWriteOptions { /* private fields */ }

Options to configure how metadata files are written.

Implementations

impl MetadataWriteOptions

pub fn new() -> Self

Creates a new set of options, all initially set to false.

pub fn set_truncate(&mut self, truncate: bool)

Sets the option to overwrite the output file if it already exists.

If true and the file path already exists, its contents will be replaced.

If false and the file path already exists, an error will be returned.

This setting has no effect if the file path does not exist.

pub fn set_write_anchors(&mut self, write_anchors: bool)

Sets the option to write YAML anchors and aliases.

If true then conditions, constraints, files, file details, plugin cleaning data details, messages and message contents that appear more than once in the metadata will be deduplicated by including a YAML anchor when writing the first occurrence of the value, and writing YAML aliases in place of further occurrences.

If false, YAML anchors and aliases will not be used, so no deduplication will occur.

pub fn set_write_common_section(&mut self, write_common_section: bool)

Sets the option to write YAML anchors in a common section.

If write_anchors is true and this is also true, the document’s root-level map will start with a common key. Its value will be a list of all the values for which YAML anchors will be written, so that all YAML anchors will appear within that list.

This setting has no effect if write_anchors is false.

pub fn set_anchor_file_strings(&mut self, anchor_file_strings: bool)

Sets the option to write anchors for File values that only have a name.

If write_anchors is true and this is also true, then all repeated File metadata values will be deduplicated using YAML anchors and aliases.

If this is false, then only File metadata that is serialised as a YAML object will be deduplicated (i.e. File values that only have a name will not be deduplicated).

This setting has no effect if write_anchors is false.

pub fn truncate(&self) -> bool

Gets the current value of the truncate option.

pub fn write_anchors(&self) -> bool

Gets the current value of the write_anchors option.

pub fn write_common_section(&self) -> bool

Gets the current value of the write_common_section option.

pub fn anchor_file_strings(&self) -> bool

Gets the current value of the anchor_file_strings option.

Trait Implementations

impl Clone for MetadataWriteOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataWriteOptions

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

Formats the value using the given formatter.

impl Default for MetadataWriteOptions

fn default() -> Self

Returns the “default value” for a type.