Struct polars::prelude::Window

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

Available on crate feature temporal only.

Represents a window in time

Fields

offset: Duration

Implementations

impl Window

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

pub fn truncate_ns(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Truncate the given ns timestamp by the window boundary.

pub fn truncate_us(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Truncate the given us timestamp by the window boundary.

pub fn truncate_ms(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Truncate the given ms timestamp by the window boundary.

pub fn round_ns(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Round the given ns timestamp by the window boundary.

pub fn round_us(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Round the given us timestamp by the window boundary.

pub fn round_ms(&self, t: i64, tz: Option<&Tz>) -> Result<i64, PolarsError>

Round the given ms timestamp by the window boundary.

pub fn get_earliest_bounds_ns( &self, t: i64, closed_window: ClosedWindow, tz: Option<&Tz> ) -> Result<Bounds, PolarsError>

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.

pub fn get_earliest_bounds_us( &self, t: i64, closed_window: ClosedWindow, tz: Option<&Tz> ) -> Result<Bounds, PolarsError>

pub fn get_earliest_bounds_ms( &self, t: i64, closed_window: ClosedWindow, tz: Option<&Tz> ) -> Result<Bounds, PolarsError>

pub fn get_overlapping_bounds_iter<'a>( &'a self, boundary: Bounds, closed_window: ClosedWindow, tu: TimeUnit, tz: Option<&'a Tz>, start_by: StartBy ) -> Result<BoundsIter<'a>, PolarsError>

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