Struct polars::prelude::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<String>,
pub ambiguous: Expr,
}
Available on crate feature
lazy
only.Expand description
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<String>
§ambiguous: Expr
Implementations§
§impl DatetimeArgs
impl DatetimeArgs
pub fn new(year: Expr, month: Expr, day: Expr) -> DatetimeArgs
pub fn new(year: Expr, month: Expr, day: Expr) -> DatetimeArgs
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) -> DatetimeArgs
pub fn with_hms(self, hour: Expr, minute: Expr, second: Expr) -> DatetimeArgs
Set hour
, minute
, and second
Equivalent to
ⓘ
self.with_hour(hour)
.with_minute(minute)
.with_second(second)
pub fn with_year(self, n: Expr) -> DatetimeArgs
pub fn with_year(self, n: Expr) -> DatetimeArgs
Set the year
pub fn with_month(self, n: Expr) -> DatetimeArgs
pub fn with_month(self, n: Expr) -> DatetimeArgs
Set the month
pub fn with_day(self, n: Expr) -> DatetimeArgs
pub fn with_day(self, n: Expr) -> DatetimeArgs
Set the day
pub fn with_hour(self, n: Expr) -> DatetimeArgs
pub fn with_hour(self, n: Expr) -> DatetimeArgs
Set the hour
pub fn with_minute(self, n: Expr) -> DatetimeArgs
pub fn with_minute(self, n: Expr) -> DatetimeArgs
Set the minute
pub fn with_second(self, n: Expr) -> DatetimeArgs
pub fn with_second(self, n: Expr) -> DatetimeArgs
Set the second
pub fn with_microsecond(self, n: Expr) -> DatetimeArgs
pub fn with_microsecond(self, n: Expr) -> DatetimeArgs
Set the microsecond
pub fn with_time_unit(self, time_unit: TimeUnit) -> DatetimeArgs
pub fn with_time_zone(self, time_zone: Option<String>) -> DatetimeArgs
Available on crate feature
timezones
only.pub fn with_ambiguous(self, ambiguous: Expr) -> DatetimeArgs
Available on crate feature
timezones
only.Trait Implementations§
§impl Clone for DatetimeArgs
impl Clone for DatetimeArgs
§fn clone(&self) -> DatetimeArgs
fn clone(&self) -> DatetimeArgs
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl Debug for DatetimeArgs
impl Debug for DatetimeArgs
§impl Default for DatetimeArgs
impl Default for DatetimeArgs
§fn default() -> DatetimeArgs
fn default() -> DatetimeArgs
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for DatetimeArgs
impl Send for DatetimeArgs
impl Sync for DatetimeArgs
impl Unpin for DatetimeArgs
impl !UnwindSafe for DatetimeArgs
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more