Struct polars_time::prelude::Window

pub struct Window {
    pub offset: Duration,
    /* private fields */
}

Represents a window in time

Fields

offset: Duration

Implementations

impl Window

pub fn new(every: Duration, period: Duration, offset: Duration) -> Self

pub fn truncate_ns(&self, t: i64) -> i64

Truncate the given ns timestamp by the window boundary.

pub fn truncate_no_offset_ns(&self, t: i64) -> i64

pub fn truncate_us(&self, t: i64) -> i64

Truncate the given ns timestamp by the window boundary.

pub fn truncate_no_offset_us(&self, t: i64) -> i64

pub fn truncate_ms(&self, t: i64) -> i64

pub fn truncate_no_offset_ms(&self, t: i64) -> i64

pub fn round_ns(&self, t: i64) -> i64

Round the given ns timestamp by the window boundary.

pub fn round_us(&self, t: i64) -> i64

Round the given us timestamp by the window boundary.

pub fn round_ms(&self, t: i64) -> i64

Round the given ms timestamp by the window boundary.

pub fn get_earliest_bounds_ns(&self, t: i64) -> Bounds

returns the bounds for the earliest window bounds that contains the given time t. For underlapping windows that do not contain time t, the window directly after time t will be returned.

For every larger than 1day we just take the given timestamp t as start as truncation does not seems intuitive. Below 1 day, it make sense to truncate to:

• days
• hours
• 15 minutes
• etc.

But for 2w3d, it does not make sense to start it on a different lower bound, so we start at t

pub fn get_earliest_bounds_us(&self, t: i64) -> Bounds

pub fn get_earliest_bounds_ms(&self, t: i64) -> Bounds

pub fn get_overlapping_bounds_iter(
    &self,
    boundary: Bounds,
    tu: TimeUnit,
    start_by: StartBy
) -> BoundsIter

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Window