Struct dicom_core::value::partial::DicomDateTime

pub struct DicomDateTime { /* private fields */ }

Represents a Dicom date-time (DT) value with a partial precision, where some date or time components may be missing.

DicomDateTime is always internally represented by a DicomDate. The DicomTime and a timezone FixedOffset values are optional.

It implements AsRange trait, which serves to retrieve a PreciseDateTime from values with missing components.

Example

use chrono::{DateTime, FixedOffset, TimeZone, NaiveDateTime, NaiveDate, NaiveTime};
use dicom_core::value::{DicomDate, DicomTime, DicomDateTime, AsRange, PreciseDateTime};

let offset = FixedOffset::east_opt(3600).unwrap();

// lets create the least precise date-time value possible 'YYYY' and make it time-zone aware
let dt = DicomDateTime::from_date_with_time_zone(
    DicomDate::from_y(2020)?,
    offset
);
// the earliest possible value is output as a [PreciseDateTime]
assert_eq!(
    dt.earliest()?,
    PreciseDateTime::TimeZone(
    offset.from_local_datetime(&NaiveDateTime::new(
        NaiveDate::from_ymd_opt(2020, 1, 1).unwrap(),
        NaiveTime::from_hms_opt(0, 0, 0).unwrap()
    )).single().unwrap())
);
assert_eq!(
    dt.latest()?,
    PreciseDateTime::TimeZone(
    offset.from_local_datetime(&NaiveDateTime::new(
        NaiveDate::from_ymd_opt(2020, 12, 31).unwrap(),
        NaiveTime::from_hms_micro_opt(23, 59, 59, 999_999).unwrap()
    )).single().unwrap())
);

let chrono_datetime = offset.from_local_datetime(&NaiveDateTime::new(
        NaiveDate::from_ymd_opt(2020, 12, 31).unwrap(),
        NaiveTime::from_hms_opt(23, 59, 0).unwrap()
    )).unwrap();

let dt = DicomDateTime::try_from(&chrono_datetime)?;
// conversion from chrono value leads to a precise value
assert_eq!(dt.is_precise(), true);

assert_eq!(dt.to_string(), "2020-12-31 23:59:00.0 +01:00");

Implementations

impl DicomDateTime

pub fn from_date_with_time_zone( date: DicomDate, time_zone: FixedOffset ) -> DicomDateTime

Constructs a new DicomDateTime from a DicomDate and a timezone FixedOffset.

pub fn from_date(date: DicomDate) -> DicomDateTime

Constructs a new DicomDateTime from a DicomDate .

pub fn from_date_and_time( date: DicomDate, time: DicomTime ) -> Result<DicomDateTime, Error>

Constructs a new DicomDateTime from a DicomDate and a DicomTime, providing that DicomDate is precise.

pub fn from_date_and_time_with_time_zone( date: DicomDate, time: DicomTime, time_zone: FixedOffset ) -> Result<DicomDateTime, Error>

Constructs a new DicomDateTime from a DicomDate, DicomTime and a timezone FixedOffset, providing that DicomDate is precise.

pub fn date(&self) -> &DicomDate

Retrieves a reference to the internal date value

pub fn time(&self) -> Option<&DicomTime>

Retrieves a reference to the internal time value, if present

pub fn time_zone(&self) -> Option<&FixedOffset>

Retrieves a reference to the internal time-zone value, if present

pub fn has_time_zone(&self) -> bool

Returns true, if the DicomDateTime contains a time-zone

pub fn offset(&self)

👎Deprecated since 0.7.0: Use time_zone instead

Retrieves a reference to the internal offset value

impl DicomDateTime

pub fn to_encoded(&self) -> String

Retrieves a dicom encoded string representation of the value.

impl DicomDateTime

pub fn to_precise_datetime(&self) -> Result<PreciseDateTime, Error>

Retrieves a PreciseDateTime from a date-time value. If the date-time value is not precise or the conversion leads to ambiguous results, it fails.

pub fn to_chrono_datetime(self) -> Result<DateTime<FixedOffset>, Error>

👎Deprecated since 0.7.0: Use to_precise_date_time()

Trait Implementations

impl AsRange for DicomDateTime

type PreciseValue = PreciseDateTime

type Range = DateTimeRange

fn is_precise(&self) -> bool

returns true if value has all possible date / time components

fn earliest(&self) -> Result<Self::PreciseValue, Error>

Returns the earliest possible value from a partial precision structure. Missing components default to 1 (days, months) or 0 (hours, minutes, …) If structure contains invalid combination of DateComponents, it fails.

fn latest(&self) -> Result<Self::PreciseValue, Error>

Returns the latest possible value from a partial precision structure. If structure contains invalid combination of DateComponents, it fails.

fn range(&self) -> Result<Self::Range, Error>

Returns a tuple of the earliest and latest possible value from a partial precision structure.

fn exact(&self) -> Result<Self::PreciseValue, Error>

Returns a corresponding precise value, if the partial precision structure has full accuracy.

impl Clone for DicomDateTime

fn clone(&self) -> DicomDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DicomDateTime

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

Formats the value using the given formatter.

impl Display for DicomDateTime

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

Formats the value using the given formatter.

impl From<DicomDateTime> for PrimitiveValue

fn from(value: DicomDateTime) -> Self

Converts to this type from the input type.

impl FromStr for DicomDateTime

type Err = Error

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.

impl PartialEq for DicomDateTime

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&NaiveDateTime> for DicomDateTime

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for DicomDateTime

impl StructuralPartialEq for DicomDateTime