Struct xmp_toolkit::IterOptions

pub struct IterOptions { /* private fields */ }

Provides options for configuring the XMP iteration behavior provided by XmpMeta::iter.

This struct defines a starting point for the iteration, and options that control how it proceeds.

By default, iteration starts at the root and visits all nodes beneath it in a depth-first manner. The root node iteself is never visited; the first visited node is a schema node. You can provide a schema name or property path to select a different starting node. In those cases, this visits the named root node first then all nodes beneath it in a depth-first manner.

Implementations

impl IterOptions

pub fn schema_ns(self, schema_ns: &str) -> Self

Restrict iteration to those properties that are part of the named schema.

pub fn property(self, schema_ns: &str, prop_name: &str) -> Self

Restrict iteration to properties within a specific property.

pub fn immediate_children_only(self) -> Self

Restrict iteration to immediate children of the root.

pub fn leaf_nodes_only(self) -> Self

Restrict iteration to leaf nodes only.

pub fn leaf_name_only(self) -> Self

Return only the leaf part of the path.

pub fn omit_qualifiers(self) -> Self

Omit all qualifiers.

Trait Implementations

impl Clone for IterOptions

fn clone(&self) -> IterOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IterOptions

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

Formats the value using the given formatter.

impl Default for IterOptions

fn default() -> IterOptions

Returns the “default value” for a type.

impl PartialEq for IterOptions

fn eq(&self, other: &IterOptions) -> 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 IterOptions

impl StructuralPartialEq for IterOptions