Skip to main content

EncodedTime

Struct EncodedTime 

Source
pub struct EncodedTime<S: Scale, F: TimeFormat> { /* private fields */ }
Expand description

A typed external encoding of a Time<S> instant.

EncodedTime<S, F> carries two phantom type parameters:

  • S: Scale — the physical time axis (TT, TAI, UTC, …).
  • F: TimeFormat — the encoding scheme (JD, MJD, J2000s, Unix, GPS).

The compiler therefore treats EncodedTime<TT, JD> and EncodedTime<UTC, JD> as completely distinct, incompatible types even though both carry a day-valued quantity internally.

Implementations§

Source§

impl<S: Scale, F: TimeFormat> EncodedTime<S, F>

Source

pub const fn from_raw_unchecked(raw: Quantity<F::Unit>) -> Self

Construct from a raw typed quantity without checking for finiteness.

For use in const contexts. The caller must ensure raw is finite; passing a non-finite value produces incorrect behaviour.

Source

pub const fn raw(self) -> Quantity<F::Unit>

Return the underlying typed quantity.

Source

pub const fn quantity(self) -> Quantity<F::Unit>

Alias for Self::raw.

Source§

impl<S: Scale> EncodedTime<S, JD>

Source

pub const J2000: Self

J2000.0 epoch as a Julian Date on scale S (JD 2 451 545.0).

Source§

impl<S: Scale, F> EncodedTime<S, F>
where F: FormatForScale<S>,

Source

pub fn try_new(raw: Quantity<F::Unit>) -> Result<Self, ConversionError>

Construct a typed encoded instant from its raw quantity.

Source

pub fn try_to_time(self) -> Result<Time<S>, ConversionError>

Convert this encoded instant to the canonical Time<S> model.

Snapshots the active time-data bundle at call time via TimeContext::new. For reproducible pipelines, prefer to_time_with with an explicit context.

Source

pub fn to_time_with(self, ctx: &TimeContext) -> Result<Time<S>, ConversionError>

Convert this encoded instant to the canonical Time<S> model using an explicit context.

Source§

impl<S: Scale, F> EncodedTime<S, F>

Source

pub fn to_time(self) -> Time<S>

Infallible conversion to the canonical Time<S> model.

Source

pub fn to<T>(self) -> T::Output

Unified infallible conversion to a target scale or encoded format.

Source

pub fn try_to<T>(self) -> Result<T::Output, ConversionError>
where T: ConversionTarget<S>,

Unified fallible conversion to a target scale or encoded format.

Source§

impl<S: Scale, F> EncodedTime<S, F>
where F: FormatForScale<S>,

Source

pub fn to_with<T>(self, ctx: &TimeContext) -> Result<T::Output, ConversionError>

Unified context-backed conversion to a target scale or encoded format.

Trait Implementations§

Source§

impl<S: Scale, F: TimeFormat> Clone for EncodedTime<S, F>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Scale, F: TimeFormat> Debug for EncodedTime<S, F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Scale, F: TimeFormat> Display for EncodedTime<S, F>
where Quantity<F::Unit>: Display,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Scale, F: TimeFormat> From<Coord<S, F>> for EncodedTime<S, F>

Source§

fn from(value: Coord<S, F>) -> Self

Converts to this type from the input type.
Source§

impl<S: Scale, F: TimeFormat> From<EncodedTime<S, F>> for Coord<S, F>

Source§

fn from(value: EncodedTime<S, F>) -> Self

Converts to this type from the input type.
Source§

impl<S: Scale, F> From<EncodedTime<S, F>> for Time<S>

Source§

fn from(value: EncodedTime<S, F>) -> Self

Converts to this type from the input type.
Source§

impl<S: Scale, F> From<Time<S>> for EncodedTime<S, F>

Source§

fn from(value: Time<S>) -> Self

Converts to this type from the input type.
Source§

impl<S: Scale, F: TimeFormat> LowerExp for EncodedTime<S, F>
where Quantity<F::Unit>: LowerExp,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Scale, F: TimeFormat> PartialEq for EncodedTime<S, F>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<S: Scale, F: TimeFormat> PartialOrd for EncodedTime<S, F>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<S: Scale, F: TimeFormat> UpperExp for EncodedTime<S, F>
where Quantity<F::Unit>: UpperExp,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Scale, F: TimeFormat> Copy for EncodedTime<S, F>

Auto Trait Implementations§

§

impl<S, F> Freeze for EncodedTime<S, F>

§

impl<S, F> RefUnwindSafe for EncodedTime<S, F>
where <F as TimeFormat>::Unit: RefUnwindSafe,

§

impl<S, F> Send for EncodedTime<S, F>
where <F as TimeFormat>::Unit: Send,

§

impl<S, F> Sync for EncodedTime<S, F>
where <F as TimeFormat>::Unit: Sync,

§

impl<S, F> Unpin for EncodedTime<S, F>
where <F as TimeFormat>::Unit: Unpin,

§

impl<S, F> UnsafeUnpin for EncodedTime<S, F>

§

impl<S, F> UnwindSafe for EncodedTime<S, F>
where <F as TimeFormat>::Unit: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.