Struct XmpMeta 

pub struct XmpMeta { /* private fields */ }

Main structure for working with XMP metadata

Implementations

impl XmpMeta

pub fn new() -> Self

Create a new empty XMP metadata object

pub fn all_properties(&self) -> Vec<XmpProperty>

Returns all top-level properties in this metadata object.

This method returns an owned iterator (it snapshots the current state), so it can be used safely without holding internal borrows/locks across iteration.

pub fn parse(s: &str) -> XmpResult<Self>

Parse XMP metadata from a string

The string should contain a complete XMP Packet (with or without the <?xpacket> wrapper).

pub fn has_property(&self, namespace: &str, path: &str) -> bool

Check if a property exists

Arguments

• namespace - The namespace URI or prefix
• path - The property path

pub fn get_property(&self, namespace: &str, path: &str) -> Option<XmpValue>

Get a property value

Arguments

• namespace - The namespace URI or prefix
• path - The property path (e.g., “CreatorTool” or “creator[1]”)

pub fn set_property( &mut self, namespace: &str, path: &str, value: XmpValue, ) -> XmpResult<()>

Set a property value

Arguments

• namespace - The namespace URI or prefix
• path - The property path
• value - The value to set

pub fn delete_property(&mut self, namespace: &str, path: &str) -> XmpResult<()>

Delete a property

Arguments

• namespace - The namespace URI or prefix
• path - The property path

pub fn about_uri(&self) -> Option<&str>

Get the about URI

pub fn set_about_uri(&mut self, uri: impl Into<String>)

Set the about URI

pub fn serialize(&self) -> XmpResult<String>

Serialize to RDF/XML string

pub fn serialize_packet(&self) -> XmpResult<String>

Serialize to XMP Packet format

pub fn serialize_packet_with_padding( &self, target_length: usize, ) -> XmpResult<String>

Serialize to XMP Packet format with padding to reach a target length

This is useful for in-place updates where the new packet needs to fit within the space of an existing packet.

Arguments

• target_length - The desired total packet length in bytes

Returns

• Ok(String) - The serialized packet with padding
• Err(XmpError) - If the serialized packet exceeds target_length

pub fn get_array_item( &self, namespace: &str, path: &str, index: usize, ) -> Option<XmpValue>

Get an array item by index

Arguments

• namespace - The namespace URI or prefix
• path - The array property path (e.g., “creator”)
• index - The array index (0-based)

pub fn get_array_size(&self, namespace: &str, path: &str) -> Option<usize>

Get the size of an array property

Arguments

• namespace - The namespace URI or prefix
• path - The array property path

pub fn append_array_item( &mut self, namespace: &str, path: &str, value: XmpValue, ) -> XmpResult<()>

Append an item to an array property

Arguments

• namespace - The namespace URI or prefix
• path - The array property path
• value - The value to append

pub fn insert_array_item( &mut self, namespace: &str, path: &str, index: usize, value: XmpValue, ) -> XmpResult<()>

Insert an item into an array property at a specific index

Arguments

• namespace - The namespace URI or prefix
• path - The array property path
• index - The index to insert at (0-based)
• value - The value to insert

pub fn delete_array_item( &mut self, namespace: &str, path: &str, index: usize, ) -> XmpResult<()>

Delete an item from an array property

Arguments

• namespace - The namespace URI or prefix
• path - The array property path
• index - The index to delete (0-based)

pub fn get_struct_field( &self, namespace: &str, struct_path: &str, field_name: &str, ) -> Option<XmpValue>

Get a structure field value

Arguments

• namespace - The namespace URI or prefix
• struct_path - The structure property path
• field_name - The field name within the structure

pub fn set_struct_field( &mut self, namespace: &str, struct_path: &str, field_name: &str, value: XmpValue, ) -> XmpResult<()>

Set a structure field value

Arguments

• namespace - The namespace URI or prefix
• struct_path - The structure property path
• field_name - The field name within the structure
• value - The value to set

pub fn delete_struct_field( &mut self, namespace: &str, struct_path: &str, field_name: &str, ) -> XmpResult<()>

Delete a structure field

Arguments

• namespace - The namespace URI or prefix
• struct_path - The structure property path
• field_name - The field name to delete

pub fn set_localized_text( &mut self, namespace: &str, property: &str, _generic_lang: &str, specific_lang: &str, value: &str, ) -> XmpResult<()>

Set a localized text property

Localized text properties are stored as rdf:Alt arrays, where each item has an xml:lang qualifier indicating its language.

Arguments

• namespace - The namespace URI or prefix
• property - The property name
• generic_lang - Generic language code (e.g., “en”), can be empty string
• specific_lang - Specific language code (e.g., “en-US”), required
• value - The text value to set

Example

use xmpkit::{XmpMeta, XmpValue};

let mut meta = XmpMeta::new();
meta.set_localized_text(
    "http://purl.org/dc/elements/1.1/",
    "title",
    "",
    "x-default",
    "Default Title"
).unwrap();

pub fn get_localized_text( &self, namespace: &str, property: &str, generic_lang: &str, specific_lang: &str, ) -> Option<(String, String)>

Get a localized text property

This method searches for a localized text value matching the specified language codes. It follows XMP language matching rules:

1. Exact match for specific_lang
2. Match for generic_lang if specific_lang not found
3. Fallback to “x-default” if neither found

Arguments

• namespace - The namespace URI or prefix
• property - The property name
• generic_lang - Generic language code (e.g., “en”), can be empty string
• specific_lang - Specific language code (e.g., “en-US”), required

Returns

Returns Some((value, actual_lang)) if found, where:

• value is the text value
• actual_lang is the actual language code used (may differ from requested)

Returns None if the property doesn’t exist or no matching language found.

Example

use xmpkit::XmpMeta;

let mut meta = XmpMeta::new();
meta.set_localized_text(
    "http://purl.org/dc/elements/1.1/",
    "title",
    "",
    "x-default",
    "Default Title"
).unwrap();

let (value, lang) = meta.get_localized_text(
    "http://purl.org/dc/elements/1.1/",
    "title",
    "",
    "x-default"
).unwrap();
assert_eq!(value, "Default Title");
assert_eq!(lang, "x-default");

pub fn set_date_time( &mut self, namespace: &str, path: &str, dt: &XmpDateTime, ) -> XmpResult<()>

Set a date/time property

This is a convenience method that validates and formats the date/time value before setting it as a property.

Arguments

• namespace - The namespace URI or prefix
• path - The property path
• dt - The date/time value

Example

use xmpkit::{XmpMeta, utils::datetime::XmpDateTime};

let mut meta = XmpMeta::new();
let mut dt = XmpDateTime::new();
dt.has_date = true;
dt.has_time = true;
dt.year = 2023;
dt.month = 12;
dt.day = 25;
dt.hour = 10;
dt.minute = 30;
dt.second = 0;
dt.has_timezone = true;
dt.tz_sign = 0; // UTC

meta.set_date_time("http://ns.adobe.com/xap/1.0/", "ModifyDate", &dt).unwrap();

pub fn get_date_time(&self, namespace: &str, path: &str) -> Option<XmpDateTime>

Get a date/time property

This is a convenience method that parses a date/time property value and returns it as an XmpDateTime.

Arguments

• namespace - The namespace URI or prefix
• path - The property path

Returns

Returns Some(XmpDateTime) if the property exists and can be parsed, None otherwise.

Example

use xmpkit::{XmpMeta, XmpValue, utils::datetime::XmpDateTime};

let mut meta = XmpMeta::new();
meta.set_property(
    "http://ns.adobe.com/xap/1.0/",
    "ModifyDate",
    XmpValue::DateTime("2023-12-25T10:30:00Z".to_string())
).unwrap();

let dt = meta.get_date_time("http://ns.adobe.com/xap/1.0/", "ModifyDate").unwrap();
assert_eq!(dt.year, 2023);
assert_eq!(dt.month, 12);
assert_eq!(dt.day, 25);

Trait Implementations

impl Clone for XmpMeta

fn clone(&self) -> XmpMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmpMeta

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

Formats the value using the given formatter.

impl Default for XmpMeta

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for XmpMeta

type Err = XmpError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.