Struct DateSeriesData 

pub struct DateSeriesData<T>(/* private fields */);

Series data that is guaranteed to use a date-based index.

This is a newtype around SeriesData<T> that guarantees is_date_based() is true, making date methods infallible.

Implementations

impl<T> DateSeriesData<T>

pub fn try_new(inner: SeriesData<T>) -> Result<DateSeriesData<T>, SeriesData<T>>

Create a DateSeriesData from a SeriesData, returning Err if the index is not date-based.

pub fn into_inner(self) -> SeriesData<T>

Consume and return the inner SeriesData.

pub fn dates(&self) -> Option<impl Iterator<Item = Date>>

Returns an iterator over dates for the index range. Returns None for sub-daily indexes (use timestamps() instead).

pub fn iter_dates(&self) -> Option<impl Iterator<Item = (Date, &T)>>

Iterate over (date, &value) pairs. Returns None for sub-daily indexes (use iter_timestamps() instead).

pub fn timestamps(&self) -> impl Iterator<Item = Timestamp>

Returns an iterator over timestamps for the index range (infallible). Works for all date-based indexes including sub-daily.

pub fn iter_timestamps(&self) -> impl Iterator<Item = (Timestamp, &T)>

Iterate over (timestamp, &value) pairs (infallible). Works for all date-based indexes including sub-daily.

Methods from Deref<Target = SeriesData<T>>

pub fn indexes(&self) -> Range<usize>

Returns an iterator over the index range.

pub fn is_date_based(&self) -> bool

Returns true if this series uses a date-based index.

pub fn dates(&self) -> Option<impl Iterator<Item = Date>>

Returns an iterator over dates for the index range. Returns None for non-date-based and sub-daily indexes (use timestamps() instead).

pub fn timestamps(&self) -> Option<impl Iterator<Item = Timestamp>>

Returns an iterator over timestamps for the index range. Works for all date-based indexes including sub-daily. Returns None for non-date-based indexes.

pub fn iter(&self) -> impl Iterator<Item = (usize, &T)>

Iterate over (index, &value) pairs.

pub fn iter_dates(&self) -> Option<impl Iterator<Item = (Date, &T)>>

Iterate over (date, &value) pairs. Returns None for non-date-based and sub-daily indexes (use iter_timestamps() instead).

pub fn iter_timestamps(&self) -> Option<impl Iterator<Item = (Timestamp, &T)>>

Iterate over (timestamp, &value) pairs. Works for all date-based indexes including sub-daily. Returns None for non-date-based indexes.

Trait Implementations

impl<T> Debug for DateSeriesData<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for DateSeriesData<T>

type Target = SeriesData<T>

The resulting type after dereferencing.

fn deref(&self) -> &<DateSeriesData<T> as Deref>::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for DateSeriesData<T>

where T: DeserializeOwned,

fn deserialize<D>( deserializer: D, ) -> Result<DateSeriesData<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.