Struct xmp_toolkit::XmpDateTime

pub struct XmpDateTime {
    pub date: Option<XmpDate>,
    pub time: Option<XmpTime>,
}

Represents the concept of date and time as expressed in XMP.

XMP understands a close variant of the ISO8601 format, where date, time, and time zone are all optional fields. These possibilities are expressed using Options.

All of the fields are signed 32 bit integers, even though most could be 8 bit. (The same is true in the underlying C++ XMP Toolkit.) This avoids overflow when doing carries for arithmetic or normalization.

The DateTime struct in the chrono crate is similar to this struct, but does not provide a way to express the optionality of date, time, and time zone in a single struct. For that reason, we did not use it in this crate.

Enable crate feature chrono to enable conversions between this struct and chrono::DateTime<FixedOffset>.

Fields

date: Option<XmpDate>

The date, if known.

time: Option<XmpTime>

The time, if known.

Implementations

impl XmpDateTime

pub fn current() -> XmpResult<Self>

Creates a new date-time struct reflecting the current time.

pub fn set_local_time_zone(&mut self) -> XmpResult<()>

Sets the time zone to the local time zone.

Can only be used when there is a time with no existing time zone (i.e. self.time.time_zone.is_none()). It is an error to call this function with an existing time zone.

In that case, the time zone value is replaced with the local time zone. The other date/time fields are not adjusted in any way.

pub fn convert_to_local_time(&mut self) -> XmpResult<()>

Translate the value to the local time zone.

If the time zone is not the local zone, the time is adjusted and the time zone set to be local. The value is not modified if the time zone is already the local zone or if the value has no time zone.

pub fn convert_to_utc(&mut self) -> XmpResult<()>

Translates the value to UTC (Coordinated Universal Time).

If the time zone is not UTC, the time is adjusted and the time zone set to be UTC. The value is not modified if the time zone is already UTC or if the value has no time zone.

Trait Implementations

impl Clone for XmpDateTime

fn clone(&self) -> XmpDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XmpDateTime

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

Formats the value using the given formatter.

impl Default for XmpDateTime

fn default() -> XmpDateTime

Returns the “default value” for a type.

impl Display for XmpDateTime

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

Formats a date according to the ISO 8601 profile in https://www.w3.org/TR/NOTE-datetime.

The format will be one of the following:

• YYYY
• YYYY-MM-DD
• YYYY-MM-DDThh:mmTZD
• YYYY-MM-DDThh:mm:ssTZD
• YYYY-MM-DDThh:mm:ss.sTZD

Where:

• YYYY = four-digit year
• MM = two-digit month (01=January)
• DD = two-digit day of month (01 through 31)
• hh = two digits of hour (00 through 23)
• mm = two digits of minute (00 through 59)
• ss = two digits of second (00 through 59)
• s = one or more digits representing a decimal fraction of a second
• TZD = time zone designator (Z or +hh:mm or -hh:mm)

XMP allows time-only values (date = None). In this case, the date portion of the output will be 0000-01-01.

NOTE: ISO 8601 does not allow years less than 1000 or greater than 9999. XmpDateTime allows any year, even negative ones. The W3C profile also requires a time zone designator if a time is present; since XmpDateTime has an explicit notion of zone-less time, the TZD will not appear in that case.

impl From<&DateTime<FixedOffset>> for XmpDateTime

fn from(dt: &DateTime<FixedOffset>) -> Self

Converts to this type from the input type.

impl From<DateTime<FixedOffset>> for XmpDateTime

fn from(dt: DateTime<FixedOffset>) -> Self

Converts to this type from the input type.

impl PartialEq for XmpDateTime

fn eq(&self, other: &XmpDateTime) -> 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 TryFrom<&XmpDateTime> for DateTime<FixedOffset>

type Error = DateTimeConvertError

The type returned in the event of a conversion error.

fn try_from(dt: &XmpDateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<XmpDateTime> for DateTime<FixedOffset>

type Error = DateTimeConvertError

The type returned in the event of a conversion error.

fn try_from(dt: XmpDateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for XmpDateTime

impl StructuralPartialEq for XmpDateTime