Struct xmp_toolkit::XmpValue

pub struct XmpValue<T: Clone + Debug + Default + PartialEq> {
    pub value: T,
    /* private fields */
}

An XMP value consists describes a simple property or an item in an array property.

Fields

value: T

Core value for this item (typically a String or scalar value).

Implementations

impl<T: Clone + Debug + Default + PartialEq> XmpValue<T>

pub fn new(value: T) -> Self

Creates a new value with default flags.

pub fn has_no_flags(&self) -> bool

Returns true if none of the other is... or has... flags for this value are true.

pub fn is_uri(&self) -> bool

Returns true if the XML string form of this property value is a URI, meaning it uses the rdf:resource attribute.

This is flagged as “discouraged” in the C++ XMP Toolkit API documentation.

pub fn set_is_uri(self, value: bool) -> Self

Set this flag if the XML string form of this property value is a URI, meaning it uses the rdf:resource attribute.

This is flagged as “discouraged” in the C++ XMP Toolkit API documentation.

pub fn has_qualifiers(&self) -> bool

Returns true if the property has qualifiers, such as rdf:type xml:lang.

pub fn set_has_qualifiers(self, value: bool) -> Self

Set this flag if the property has qualifiers, such as rdf:type xml:lang.

pub fn is_qualifier(&self) -> bool

Returns true if this property is a qualifier for some other property, such as rdf:type and xml:lang.

Qualifiers can have arbitrary structure, and can themselves have qualifiers. If the qualifier itself has a structured value, this flag is only set for the top node of the qualifier’s subtree.

pub fn set_is_qualifier(self, value: bool) -> Self

Set this flag if this property is a qualifier for some other property, such as rdf:type and xml:lang.

Qualifiers can have arbitrary structure, and can themselves have qualifiers. If the qualifier itself has a structured value, this flag is only set for the top node of the qualifier’s subtree.

pub fn has_lang(&self) -> bool

Returns true if this property has an xml:lang qualifier.

Implies has_qualifiers will also be true.

pub fn set_has_lang(self, value: bool) -> Self

Set this flag if this property has an xml:lang qualifier.

Implies has_qualifiers will also be true.

pub fn has_type(&self) -> bool

Returns true if this property has an rdf:type qualifier.

Implies has_qualifiers will also be true.

pub fn set_has_type(self, value: bool) -> Self

Set this flag if this property has an rdf:type qualifier.

Implies has_qualifiers will also be true.

pub fn is_struct(&self) -> bool

Returns true if this value is a structure with nested fields.

pub fn set_is_struct(self, value: bool) -> Self

Set this flag if this value is a structure with nested fields.

pub fn is_array(&self) -> bool

Returns true if this value is an array (RDF alt/bag/seq).

This may mean the array is ordered or unordered. Use the is_ordered query to discern between the two.

pub fn set_is_array(self, value: bool) -> Self

Set this flag if this value is an array (RDF alt/bag/seq).

This may mean the array is ordered or unordered. Use the is_ordered query to discern between the two.

pub fn is_ordered(&self) -> bool

Returns true if the item order matters. In other words, this array has been serialized using an rdf:Seq container.

Implies that is_array is also true.

pub fn set_is_ordered(self, value: bool) -> Self

Set this flag if the item order matters. In other words, this array has been serialized using an rdf:Seq container.

Implies that is_array is also true.

pub fn is_alternate(&self) -> bool

Returns true if the items in this array are alternates. In other words, this array has been serialized using an rdf:Alt container.

Implies that is_array and is_ordered are also true.

pub fn set_is_alternate(self, value: bool) -> Self

Set this flag if the items in this array are alternates. In other words, this array has been serialized using an rdf:Alt container.

Implies that is_array and is_ordered are also true.

pub fn is_alt_text(&self) -> bool

Returns true if items are localized text. Each array element will be a simple property with an xml:lang attribute.

Implies is_alternate is also true.

pub fn set_is_alt_text(self, value: bool) -> Self

Set this flag if items are localized text. Each array element will be a simple property with an xml:lang attribute.

Implies is_alternate is also true.

pub fn is_alias(&self) -> bool

Returns true if this property is an alias name for another property.

This is only returned by XmpMeta::property and then only if the property name is simple, not a path expression.

pub fn set_is_alias(self, value: bool) -> Self

Set this flag if this property is an alias name for another property.

pub fn has_aliases(&self) -> bool

Returns true if this property is the base value (actual) for a set of aliases.

This is only returned by XmpMeta::property and then only if the property name is simple, not a path expression.

pub fn set_has_aliases(self, value: bool) -> Self

Set this flag if this property is the base value (actual) for a set of aliases.

pub fn is_internal(&self) -> bool

Returns true if this property is “owned” by the application, and should not generally be editable in a UI.

pub fn set_is_internal(self, value: bool) -> Self

Set this flag if this property is “owned” by the application, and should not generally be editable in a UI.

pub fn is_stable(&self) -> bool

Returns true if the value of this property is not derived from the document content.

pub fn set_is_stable(self, value: bool) -> Self

Set this flag if the value of this property is not derived from the document content.

pub fn is_derived(&self) -> bool

Returns true if the value of this property is derived from the document content.

pub fn set_is_derived(self, value: bool) -> Self

Set this flag if the value of this property is derived from the document content.

pub fn is_schema_node(&self) -> bool

Returns true if this property is an schema node, which is created implicitly during iteration via XmpIterator.

Trait Implementations

impl<T: Clone + Clone + Debug + Default + PartialEq> Clone for XmpValue<T>

fn clone(&self) -> XmpValue<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Debug + Default + PartialEq> Debug for XmpValue<T>

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

Formats the value using the given formatter.

impl<T: Default + Clone + Debug + Default + PartialEq> Default for XmpValue<T>

fn default() -> XmpValue<T>

Returns the “default value” for a type.

impl From<&str> for XmpValue<String>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<T> for XmpValue<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: PartialEq + Clone + Debug + Default + PartialEq> PartialEq<XmpValue<T>> for XmpValue<T>

fn eq(&self, other: &XmpValue<T>) -> 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<T: Eq + Clone + Debug + Default + PartialEq> Eq for XmpValue<T>

impl<T: Clone + Debug + Default + PartialEq> StructuralEq for XmpValue<T>

impl<T: Clone + Debug + Default + PartialEq> StructuralPartialEq for XmpValue<T>