Pkg/polars/Duration

Duration

struct Duration

A duration type.

Operators

pub fn operator <=(self, b: Duration): bool

pub fn operator <(self, b: Duration): bool

pub fn operator >=(self, b: Duration): bool

pub fn operator >(self, b: Duration): bool

pub fn operator !=(self, b: Duration): bool

pub fn operator ==(self, b: Duration): bool

Static Methods

pub fn new(fixed_slots: int): Duration

Create a new integer size Duration.

pub fn parse(s: string): Duration throws PolarsError

Parse a string into a Duration.

Strings are composed of a sequence of number-unit pairs, such as 5d (5 days). A string may begin with a minus sign, in which case it is interpreted as a negative duration.

Some examples:

"1y": 1 year
"-1w2d": negative 1 week, 2 days (i.e. -9 days) -"3d12h4m25s": 3 days, 12 hours, 4 minutes, and 25 seconds

Aside from a leading minus sign, strings may not contain any characters other than numbers and letters (including whitespace).

The available units, in ascending order of magnitude, are as follows: ns: nanosecond us: microsecond ms: millisecond s: second m: minute h: hour d: day w: week mo: calendar month q: calendar quarter y: calendar year i: index value (only for {Int32, Int64} dtypes)

By “calendar day”, we mean the corresponding time on the next day (which may not be 24 hours, depending on daylight savings). Similarly for “calendar week”, “calendar month”, “calendar quarter”, and “calendar year”.

pub fn parse_interval(s: string): Duration throws PolarsError

Methods

pub fn add_ms(self, t: int) throws PolarsError

pub fn add_ns(self, t: int) throws PolarsError

pub fn add_us(self, t: int) throws PolarsError

pub fn days(self): int

pub fn days_only(self): bool

pub fn is_constant_duration(self, tz: string? = nil): bool

pub fn is_full_days(self): bool

Returns whether the duration consists of full days.

Note that 24 hours is not considered a full day due to possible daylight savings time transitions.

pub fn is_zero(self): bool

Returns true if the duration is zero.

pub fn months(self): int

pub fn months_only(self): bool

pub fn nanoseconds(self): int

Returns the nanoseconds from the Duration without the weeks or months part.

pub fn negative(self): bool

Returns whether duration is negative.

pub fn truncate_ms(self, t: int) throws PolarsError

pub fn truncate_ns(self, t: int) throws PolarsError

pub fn truncate_us(self, t: int) throws PolarsError

pub fn weeks(self): int

pub fn weeks_only(self): bool