polars_plan::dsl::functions

Struct DurationArgs

Source
pub struct DurationArgs {
    pub weeks: Expr,
    pub days: Expr,
    pub hours: Expr,
    pub minutes: Expr,
    pub seconds: Expr,
    pub milliseconds: Expr,
    pub microseconds: Expr,
    pub nanoseconds: Expr,
    pub time_unit: TimeUnit,
}
Available on crate feature temporal only.
Expand description

Arguments used by duration in order to produce an Expr of Duration

To construct a DurationArgs, use struct literal syntax with ..Default::default() to leave unspecified fields at their default value of lit(0), as demonstrated below.

let args = DurationArgs {
    days: lit(5),
    hours: col("num_hours"),
    minutes: col("num_minutes"),
    ..Default::default()  // other fields are lit(0)
};

If you prefer builder syntax, with_* methods are also available.

let args = DurationArgs::new().with_weeks(lit(42)).with_hours(lit(84));

Fields§

§weeks: Expr§days: Expr§hours: Expr§minutes: Expr§seconds: Expr§milliseconds: Expr§microseconds: Expr§nanoseconds: Expr§time_unit: TimeUnit

Implementations§

Source§

impl DurationArgs

Source

pub fn new() -> Self

Create a new DurationArgs with all fields set to lit(0). Use the with_* methods to set the fields.

Source

pub fn with_hms(self, hours: Expr, minutes: Expr, seconds: Expr) -> Self

Set hours, minutes, and seconds

Equivalent to:

self.with_hours(hours)
    .with_minutes(minutes)
    .with_seconds(seconds)
Source

pub fn with_fractional_seconds( self, milliseconds: Expr, microseconds: Expr, nanoseconds: Expr, ) -> Self

Set milliseconds, microseconds, and nanoseconds

Equivalent to

self.with_milliseconds(milliseconds)
    .with_microseconds(microseconds)
    .with_nanoseconds(nanoseconds)
Source

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

Set the weeks

Source

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

Set the days

Source

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

Set the hours

Source

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

Set the minutes

Source

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

Set the seconds

Source

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

Set the milliseconds

Source

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

Set the microseconds

Source

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

Set the nanoseconds

Trait Implementations§

Source§

impl Clone for DurationArgs

Source§

fn clone(&self) -> DurationArgs

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DurationArgs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DurationArgs

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Ungil for T
where T: Send,