Struct polars_plan::dsl::functions::DatetimeArgs

pub struct DatetimeArgs {
    pub year: Expr,
    pub month: Expr,
    pub day: Expr,
    pub hour: Expr,
    pub minute: Expr,
    pub second: Expr,
    pub microsecond: Expr,
    pub time_unit: TimeUnit,
    pub time_zone: Option<TimeZone>,
    pub ambiguous: Expr,
}

Arguments used by datetime in order to produce an Expr of Datetime

Construct a DatetimeArgs with DatetimeArgs::new(y, m, d). This will set the other time units to lit(0). You can then set the other fields with the with_* methods, or use with_hms to set hour, minute, and second all at once.

Examples

use polars_plan::prelude::*;
// construct a DatetimeArgs set to July 20, 1969 at 20:17
let args = DatetimeArgs::new(lit(1969), lit(7), lit(20)).with_hms(lit(20), lit(17), lit(0));
// or
let args = DatetimeArgs::new(lit(1969), lit(7), lit(20)).with_hour(lit(20)).with_minute(lit(17));

// construct a DatetimeArgs using existing columns
let args = DatetimeArgs::new(lit(2023), col("month"), col("day"));

Fields

year: Expr

month: Expr

day: Expr

hour: Expr

minute: Expr

second: Expr

microsecond: Expr

time_unit: TimeUnit

time_zone: Option<TimeZone>

ambiguous: Expr

Implementations

impl DatetimeArgs

pub fn new(year: Expr, month: Expr, day: Expr) -> Self

Construct a new DatetimeArgs set to year, month, day

Other fields default to lit(0). Use the with_* methods to set them.

pub fn with_hms(self, hour: Expr, minute: Expr, second: Expr) -> Self

Set hour, minute, and second

Equivalent to

self.with_hour(hour)
    .with_minute(minute)
    .with_second(second)

pub fn with_year(self, n: Expr) -> Self

Set the year

pub fn with_month(self, n: Expr) -> Self

Set the month

pub fn with_day(self, n: Expr) -> Self

Set the day

pub fn with_hour(self, n: Expr) -> Self

Set the hour

pub fn with_minute(self, n: Expr) -> Self

Set the minute

pub fn with_second(self, n: Expr) -> Self

Set the second

pub fn with_microsecond(self, n: Expr) -> Self

Set the microsecond

pub fn with_time_unit(self, time_unit: TimeUnit) -> Self

pub fn with_time_zone(self, time_zone: Option<TimeZone>) -> Self

Available on crate feature timezones only.

pub fn with_ambiguous(self, ambiguous: Expr) -> Self

Available on crate feature timezones only.

Trait Implementations

impl Clone for DatetimeArgs

fn clone(&self) -> DatetimeArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatetimeArgs

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

Formats the value using the given formatter.

impl Default for DatetimeArgs

fn default() -> Self

Returns the “default value” for a type.