Trait polars::prelude::DateMethods

source · 
pub trait DateMethods: AsDate {
    // Required method
    fn parse_from_str_slice(
        name: &str,
        v: &[&str],
        fmt: &str
    ) -> Logical<DateType, Int32Type>;

    // Provided methods
    fn year(&self) -> ChunkedArray<Int32Type> { ... }
    fn is_leap_year(&self) -> ChunkedArray<BooleanType> { ... }
    fn iso_year(&self) -> ChunkedArray<Int32Type> { ... }
    fn quarter(&self) -> ChunkedArray<Int8Type> { ... }
    fn month(&self) -> ChunkedArray<Int8Type> { ... }
    fn weekday(&self) -> ChunkedArray<Int8Type> { ... }
    fn week(&self) -> ChunkedArray<Int8Type> { ... }
    fn day(&self) -> ChunkedArray<Int8Type> { ... }
    fn ordinal(&self) -> ChunkedArray<Int16Type> { ... }
}
Available on crate feature temporal only.

Required Methods§

source

fn parse_from_str_slice( name: &str, v: &[&str], fmt: &str ) -> Logical<DateType, Int32Type>

Provided Methods§

source

fn year(&self) -> ChunkedArray<Int32Type>

Extract month from underlying NaiveDate representation. Returns the year number in the calendar date.

source

fn is_leap_year(&self) -> ChunkedArray<BooleanType>

Extract year from underlying NaiveDate representation. Returns whether the year is a leap year.

source

fn iso_year(&self) -> ChunkedArray<Int32Type>

This year number might not match the calendar year number.

source

fn quarter(&self) -> ChunkedArray<Int8Type>

Extract month from underlying NaiveDateTime representation. Quarters range from 1 to 4.

source

fn month(&self) -> ChunkedArray<Int8Type>

Extract month from underlying NaiveDateTime representation. Returns the month number starting from 1.

The return value ranges from 1 to 12.

source

fn weekday(&self) -> ChunkedArray<Int8Type>

Extract ISO weekday from underlying NaiveDate representation. Returns the weekday number where monday = 1 and sunday = 7

source

fn week(&self) -> ChunkedArray<Int8Type>

Returns the ISO week number starting from 1. The return value ranges from 1 to 53. (The last week of year differs by years.)

source

fn day(&self) -> ChunkedArray<Int8Type>

Extract day from underlying NaiveDate representation. Returns the day of month starting from 1.

The return value ranges from 1 to 31. (The last day of month differs by months.)

source

fn ordinal(&self) -> ChunkedArray<Int16Type>

Returns the day of year starting from 1.

The return value ranges from 1 to 366. (The last day of year differs by years.)

Object Safety§

This trait is not object safe.

Implementors§