Struct IndexSpace 

pub struct IndexSpace {
    pub time_unit: TimeUnit,
    /* private fields */
}

Available on crate feature temporal only.

The i64 space a temporal group-by computes its windows in: the unit and zone of the Datetime the index is cast to.

Fields

time_unit: TimeUnit

Implementations

impl IndexSpace

pub fn dynamic(index_dtype: &DataType) -> Result<IndexSpace, PolarsError>

The space for a group_by_dynamic index of index_dtype, which must be a Datetime, Date or signed integer.

A zone chrono-tz cannot parse, which needs POLARS_IGNORE_TIMEZONE_PARSE_ERROR=1 or the timezones feature to be off, is kept in time_zone but ignored for the arithmetic: the engines compute such windows as if the index had no zone, and so does this.

pub fn rolling(index_dtype: &DataType) -> Result<IndexSpace, PolarsError>

The space for a rolling index of index_dtype, which may also be an unsigned integer. See Self::dynamic for the zone handling.

pub fn tz(&self) -> Option<&Tz>

The zone the arithmetic runs in, as Duration and Window take it. None when the index has no zone or one the engines ignore, see Self::dynamic.

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

The zone of the Datetime dtype of this space.

pub fn window_dtype(&self) -> DataType

The Datetime dtype of this space.

pub fn cast_to_space(&self, index: &Column) -> Result<Column, PolarsError>

index, a column of the dtype this space was made for, cast to Self::window_dtype.

pub fn cast_from_space(&self, column: &Column) -> Result<Column, PolarsError>

column, in Self::window_dtype, cast back to the dtype this space was made for.

pub fn cast_to_boundary(&self, column: &Column) -> Result<Column, PolarsError>

column, in Self::window_dtype, cast to the dtype of a group_by_dynamic window boundary: the index dtype, except that boundaries of a Date index stay a Datetime because a window need not start on a day.

Trait Implementations

impl Clone for IndexSpace

fn clone(&self) -> IndexSpace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexSpace

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

Formats the value using the given formatter.