Struct DicomDate

pub struct DicomDate(/* private fields */);

Represents a Dicom date (DA) value with a partial precision, where some date components may be missing.

Unlike chrono::NaiveDate, it does not allow for negative years.

DicomDate implements AsRange trait, enabling to retrieve specific date values.

Example

use chrono::NaiveDate;
use dicom_core::value::{DicomDate, AsRange};

let date = DicomDate::from_y(1492)?;

assert_eq!(
    Some(date.latest()?),
    NaiveDate::from_ymd_opt(1492,12,31)
);

let date = DicomDate::try_from(&NaiveDate::from_ymd_opt(1900, 5, 3).unwrap())?;
// conversion from chrono value leads to a precise value
assert_eq!(date.is_precise(), true);

assert_eq!(date.to_string(), "1900-05-03");

Implementations

impl DicomDate

pub fn from_y(year: u16) -> Result<DicomDate, Error>

Constructs a new DicomDate with year precision (YYYY)

pub fn from_ym(year: u16, month: u8) -> Result<DicomDate, Error>

Constructs a new DicomDate with year and month precision (YYYYMM)

pub fn from_ymd(year: u16, month: u8, day: u8) -> Result<DicomDate, Error>

Constructs a new DicomDate with a year, month and day precision (YYYYMMDD)

pub fn year(&self) -> &u16

Retrieves the year from a date as a reference

pub fn month(&self) -> Option<&u8>

Retrieves the month from a date as a reference

pub fn day(&self) -> Option<&u8>

Retrieves the day from a date as a reference

impl DicomDate

pub fn to_encoded(&self) -> String

Retrieves a dicom encoded string representation of the value.

impl DicomDate

pub fn to_naive_date(self) -> Result<NaiveDate, Error>

Retrieves a chrono::NaiveDate if the value is precise up to the day of the month.

Trait Implementations

impl AsRange for DicomDate

type PreciseValue = NaiveDate

type Range = DateRange

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 DicomDate

fn clone(&self) -> DicomDate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DicomDate

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

Formats the value using the given formatter.

impl Display for DicomDate

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

Formats the value using the given formatter.

impl From<DicomDate> for PrimitiveValue

fn from(value: DicomDate) -> Self

Converts to this type from the input type.

impl<I, P> From<DicomDate> for Value<I, P>

fn from(value: DicomDate) -> Self

Converts the DICOM date into a primitive value.

impl PartialEq for DicomDate

fn eq(&self, other: &DicomDate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&NaiveDate> for DicomDate

type Error = Error

The type returned in the event of a conversion error.

fn try_from(date: &NaiveDate) -> Result<Self, Error>

Performs the conversion.

impl Copy for DicomDate

impl StructuralPartialEq for DicomDate