Skip to main content

DateMethods

polars_python::prelude

Trait DateMethods 

Source 
pub trait DateMethods: AsDate {
    // Required method
    fn parse_from_str_slice(
        name: PlSmallStr,
        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 days_in_month(&self) -> ChunkedArray<Int8Type> { ... }
    fn week(&self) -> ChunkedArray<Int8Type> { ... }
    fn day(&self) -> ChunkedArray<Int8Type> { ... }
    fn ordinal(&self) -> ChunkedArray<Int16Type> { ... }
    fn new_from_parts(
        year: &ChunkedArray<Int32Type>,
        month: &ChunkedArray<Int8Type>,
        day: &ChunkedArray<Int8Type>,
        name: PlSmallStr,
    ) -> Result<Logical<DateType, Int32Type>, PolarsError> { ... }
}

Required Methods§

Source

fn parse_from_str_slice( name: PlSmallStr, 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 days_in_month(&self) -> ChunkedArray<Int8Type>

Returns the number of days in the month of the underlying NaiveDate representation.

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.)

Source

fn new_from_parts( year: &ChunkedArray<Int32Type>, month: &ChunkedArray<Int8Type>, day: &ChunkedArray<Int8Type>, name: PlSmallStr, ) -> Result<Logical<DateType, Int32Type>, PolarsError>

Construct a date ChunkedArray from individual time components.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§