Struct xmp_toolkit::ToStringOptions

pub struct ToStringOptions { /* private fields */ }

Provides options for configuring the XMP serialization behavior provided by XmpMeta::to_string_with_options.

Note that the Rust XMP Toolkit only provides UTF-8 string encodings. No API is provided for accessing UTF-16 or UTF-32 string encodings.

We would welcome a PR that adds UTF-16 or UTF-32 encoding if you need it, but we have no plans to implement this ourselves.

Implementations

impl ToStringOptions

pub fn set_padding(self, padding: u32) -> Self

Set the amount of padding to be added if a writeable XML packet is created.

If zero or this function is not called, an appropriate amount of padding is computed.

pub fn set_newline(self, newline: String) -> Self

Set the string to be used as a line terminator.

If empty or this function is not called, defaults to linefeed, U+000A, the standard XML newline.

pub fn set_indent_string(self, indent: String) -> Self

Set the string to be used for each level of indentation in the serialized RDF.

If empty or this function is not called, defaults to two ASCII spaces, U+0020.

pub fn set_base_indent(self, base_indent: u32) -> Self

Set the number of levels of indentation to be used for the outermost XML element in the serialized RDF. This is convenient when embedding the RDF in other text.

If this function is not called, the outermost XML element will have no indentation applied.

pub fn omit_packet_wrapper(self) -> Self

Do not include an XML packet wrapper.

This can not be specified together with ToStringOptions::read_only_packet, ToStringOptions::include_thumbnail_pad, or ToStringOptions::exact_packet_length.

pub fn read_only_packet(self) -> Self

Create a read-only XML packet wapper.

This can not be specified together with ToStringOptions::omit_packet_wrapper.

pub fn use_compact_format(self) -> Self

Use a highly compact RDF syntax and layout.

pub fn use_canonical_format(self) -> Self

Use a canonical form of RDF.

pub fn include_thumbnail_pad(self) -> Self

Include typical space for a JPEG thumbnail in the padding if no xmp:Thumbnails property is present.

This can not be specified together with ToStringOptions::omit_packet_wrapper.

pub fn exact_packet_length(self) -> Self

The padding parameter provides the overall packet length. The actual amount of padding is computed. An error is returned if the packet exceeds this length with no padding.

This can not be specified together with ToStringOptions::omit_packet_wrapper.

pub fn omit_all_formatting(self) -> Self

Omit all formatting whitespace.

pub fn omit_xmp_meta_element(self) -> Self

Omit the x:xmpmeta element surrounding the rdf:RDF element.

pub fn include_rdf_hash(self) -> Self

Include a rdf Hash and Merged flag in x:xmpmeta element.

Trait Implementations

impl Clone for ToStringOptions

fn clone(&self) -> ToStringOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToStringOptions

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

Formats the value using the given formatter.

impl Default for ToStringOptions

fn default() -> ToStringOptions

Returns the “default value” for a type.

impl PartialEq<ToStringOptions> for ToStringOptions

fn eq(&self, other: &ToStringOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ToStringOptions

impl StructuralEq for ToStringOptions

impl StructuralPartialEq for ToStringOptions