Struct Duration

pub struct Duration {
    pub parsed_int: bool,
    /* private fields */
}

Fields

parsed_int: bool

Implementations

impl Duration

pub fn new(fixed_slots: i64) -> Self

Create a new integer size Duration

pub fn parse(duration: &str) -> Self

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

Panics

If the given str is invalid for any reason.

pub fn try_parse(duration: &str) -> PolarsResult<Self>

pub fn try_parse_interval(interval: &str) -> PolarsResult<Self>

pub fn is_zero(&self) -> bool

true if zero duration.

pub fn months_only(&self) -> bool

pub fn months(&self) -> i64

pub fn weeks_only(&self) -> bool

pub fn weeks(&self) -> i64

pub fn days_only(&self) -> bool

pub fn days(&self) -> i64

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_constant_duration(&self, time_zone: Option<&str>) -> bool

pub fn nanoseconds(&self) -> i64

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_impl<F, G, J>( &self, t: i64, tz: Option<&Tz>, nsecs_to_unit: F, timestamp_to_datetime: G, datetime_to_timestamp: J, ) -> PolarsResult<i64>

where F: Fn(i64) -> i64, G: Fn(i64) -> NaiveDateTime, J: Fn(NaiveDateTime) -> i64,

pub fn truncate_ns(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

pub fn truncate_us(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

pub fn truncate_ms(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

pub fn add_ns(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

pub fn add_us(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

pub fn add_ms(&self, t: i64, tz: Option<&Tz>) -> PolarsResult<i64>

Trait Implementations

impl Clone for Duration

fn clone(&self) -> Duration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Duration

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

Formats the value using the given formatter.

impl Display for Duration

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

Formats the value using the given formatter.

impl Hash for Duration

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<i64> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self

Performs the * operation.

impl Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Duration

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Duration

fn eq(&self, other: &Duration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Duration

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration