Struct IonDateTime

pub struct IonDateTime { /* private fields */ }

Higher-level wrapper over DateTime preserving ION_TIMESTAMP properties that DateTime does not preserve on its own.

Specifically, this adds the precision of the timestamp and its associated kind of offset.

Usage

Generally, users will create their own DateTime<FixedOffset> and construct an IonDateTime indicating the precision as follows:

// construct a DateTime with milliseconds of fractional seconds
use ion_c_sys::timestamp::Mantissa::Digits;
let dt = DateTime::parse_from_rfc3339("2020-02-27T04:15:00.123Z").unwrap();
// move that into an IonDateTime with the explicit milliseconds of precision
let ion_dt = IonDateTime::try_new(dt, Fractional(Digits(3)), KnownOffset)?;

Implementations

impl IonDateTime

pub fn try_new( date_time: DateTime<FixedOffset>, precision: TSPrecision, offset_kind: TSOffsetKind, ) -> IonCResult<Self>

Constructs a new IonDateTime from its constituent components.

Note that the Fractional precision must match the nanoseconds field of this will fail. Also note that the TSOffsetKind must be Unknown for precision less than a Minute and must correspond to UTC+00:00 in the DateTime.

pub fn as_datetime(&self) -> &DateTime<FixedOffset>

Returns a reference to the underlying DateTime.

pub fn precision(&self) -> &TSPrecision

Returns the precision of this IonDateTime.

pub fn offset_kind(&self) -> TSOffsetKind

Returns the offset of this IonDateTime.

pub fn into_datetime(self) -> DateTime<FixedOffset>

Consumes the underlying components of this IonDateTime into a DateTime.

Trait Implementations

impl Clone for IonDateTime

fn clone(&self) -> IonDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IonDateTime

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

Formats the value using the given formatter.

impl PartialEq for IonDateTime

fn eq(&self, other: &IonDateTime) -> 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 Eq for IonDateTime

impl StructuralPartialEq for IonDateTime