Struct Window

pub struct Window { /* private fields */ }

Primary utility struct for defining window in DataFrames

Implementations

impl Window

pub fn new() -> Self

Creates a new empty WindowSpec

pub fn current_row() -> i64

Returns 0

pub fn unbounded_following() -> i64

Returns i64::MAX

pub fn unbounded_preceding() -> i64

Returns i64::MIN

pub fn partition_by<I: ToVecExpr>(self, cols: I) -> WindowSpec

Creates a WindowSpec with the partitioning defined

pub fn order_by<I, T>(self, cols: I) -> WindowSpec

where T: ToExpr, I: IntoIterator<Item = T>,

Creates a WindowSpec with the ordering defined

pub fn range_between(self, start: i64, end: i64) -> WindowSpec

Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

Both start and end are relative from the current row. For example, “0” means “current row”, while “-1” means one off before the current row, and “5” means the five off after the current row.

Recommended to use [Window::unboundedPreceding], [Window::unboundedFollowing], and [Window::currentRow] to specify special boundary values, rather than using integral values directly.

Example

let window = Window::new()
    .partition_by(col("name"))
    .order_by([col("age")])
    .range_between(Window::unboundedPreceding(), Window::currentRow());

let df = df.with_column("rank", rank().over(window.clone()))
    .with_column("min", min("age").over(window));

pub fn rows_between(self, start: i64, end: i64) -> WindowSpec

Creates a WindowSpec with the frame boundaries defined, from start (inclusive) to end (inclusive).

Both start and end are relative from the current row. For example, “0” means “current row”, while “-1” means one off before the current row, and “5” means the five off after the current row.

Recommended to use [Window::unboundedPreceding], [Window::unboundedFollowing], and [Window::currentRow] to specify special boundary values, rather than using integral values directly.

Example

let window = Window::new()
    .partition_by(col("name"))
    .order_by([col("age")])
    .rows_between(Window::unbounded_preceding(), Window::current_row());

let df = df.with_column("rank", rank().over(window.clone()))
    .with_column("min", min("age").over(window));

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 Debug for Window

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

Formats the value using the given formatter.

impl Default for Window

fn default() -> Window

Returns the “default value” for a type.