Struct mz_repr::adt::interval::Interval

pub struct Interval {
    pub months: i32,
    pub days: i32,
    pub micros: i64,
}

An interval of time meant to express SQL intervals.

Obtained by parsing an INTERVAL '<value>' <unit> [TO <precision>].

Fields

months: i32

A possibly negative number of months for field types like YEAR

days: i32

A possibly negative number of days.

Irrespective of values, days will not be carried over into months.

micros: i64

A timespan represented in microseconds.

Irrespective of values, micros will not be carried over into days or months.

Implementations

impl Interval

pub const CENTURY_PER_MILLENNIUM: u16 = 10u16

pub const DECADE_PER_CENTURY: u16 = 10u16

pub const YEAR_PER_DECADE: u16 = 10u16

pub const MONTH_PER_YEAR: u16 = 12u16

pub const DAY_PER_MONTH: u16 = 30u16

pub const HOUR_PER_DAY: u16 = 24u16

pub const MINUTE_PER_HOUR: u16 = 60u16

pub const SECOND_PER_MINUTE: u16 = 60u16

pub const MILLISECOND_PER_SECOND: u16 = 1_000u16

pub const MICROSECOND_PER_MILLISECOND: u16 = 1_000u16

pub const NANOSECOND_PER_MICROSECOND: u16 = 1_000u16

pub const EPOCH_DAYS_PER_YEAR: f64 = 365.25f64

pub const fn new(months: i32, days: i32, micros: i64) -> Interval

Constructs a new Interval with the specified units of time.

pub fn from_duration(duration: &Duration) -> Result<Interval, Error>

Converts a Duration to an Interval. The resulting Interval will only have microseconds. Errors if

• the number of microseconds doesn’t fit in i64, or
• the Duration involves fractional microseconds.

pub fn checked_add(&self, other: &Self) -> Option<Self>

pub fn checked_mul(&self, other: f64) -> Option<Self>

pub fn checked_div(&self, other: f64) -> Option<Self>

fn checked_op<F1>(&self, other: f64, op: F1) -> Option<Self>

where F1: Fn(f64, f64) -> f64,

pub fn millennia(&self) -> i32

Computes the millennium part of the interval.

The millennium part is the number of whole millennia in the interval. For example, this function returns 3 for the interval 3400 years.

pub fn centuries(&self) -> i32

Computes the century part of the interval.

The century part is the number of whole centuries in the interval. For example, this function returns 3 for the interval 340 years.

pub fn decades(&self) -> i32

Computes the decade part of the interval.

The decade part is the number of whole decades in the interval. For example, this function returns 3 for the interval 34 years.

pub fn years(&self) -> i32

Computes the year part of the interval.

The year part is the number of whole years in the interval. For example, this function returns 3 for the interval 3 years 4 months.

pub fn quarters(&self) -> i32

Computes the quarter part of the interval.

The quarter part is obtained from taking the number of whole months modulo 12, and assigning quarter #1 for months 0-2, #2 for 3-5, #3 for 6-8 and #4 for 9-11. For example, this function returns 4 for the interval 11 months.

pub fn months(&self) -> i32

Computes the month part of the interval.

The month part is the number of whole months in the interval, modulo 12. For example, this function returns 4 for the interval 3 years 4 months.

pub fn days(&self) -> i64

Computes the day part of the interval.

The day part is the number of whole days in the interval. For example, this function returns 5 for the interval 5 days 4 hours 3 minutes 2.1 seconds.

pub fn hours(&self) -> i64

Computes the hour part of the interval.

The hour part is the number of whole hours in the interval, modulo 24. For example, this function returns 4 for the interval 5 days 4 hours 3 minutes 2.1 seconds.

pub fn minutes(&self) -> i64

Computes the minute part of the interval.

The minute part is the number of whole minutes in the interval, modulo 60. For example, this function returns 3 for the interval 5 days 4 hours 3 minutes 2.1 seconds.

pub fn seconds<T>(&self) -> T

where T: DecimalLike,

Computes the second part of the interval.

The second part is the number of fractional seconds in the interval, modulo 60.0.

pub fn milliseconds<T>(&self) -> T

where T: DecimalLike,

Computes the second part of the interval displayed in milliseconds.

The second part is the number of fractional seconds in the interval, modulo 60.0.

pub fn microseconds<T>(&self) -> T

where T: DecimalLike,

Computes the second part of the interval displayed in microseconds.

The second part is the number of fractional seconds in the interval, modulo 60.0.

pub fn nanoseconds(&self) -> i32

Computes the nanosecond part of the interval.

pub fn as_epoch_seconds<T>(&self) -> T

where T: DecimalLike,

Computes the total number of epoch seconds in the interval. When extracting an epoch, PostgreSQL considers a year 365.25 days.

pub fn as_microseconds(&self) -> i128

Computes the total number of microseconds in the interval.

pub fn as_milliseconds(&self) -> i128

Computes the total number of milliseconds in the interval. Discards fractional milliseconds!

pub fn duration_as_chrono(&self) -> Duration

Converts this Interval’s duration into chrono::Duration.

pub fn duration(&self) -> Result<Duration, Error>

pub fn truncate_high_fields(&mut self, f: DateTimeField)

Truncate the “head” of the interval, removing all time units greater than f.

pub fn truncate_low_fields( &mut self, f: DateTimeField, fsec_max_precision: Option<u64>, round_behavior: RoundBehavior, ) -> Result<(), Error>

Truncate the “tail” of the interval, removing all time units less than f.

Arguments

• f: Round the interval down to the specified time unit.
• fsec_max_precision: If Some(x), keep only x places of microsecond precision. Must be (0,6).

Errors

• If fsec_max_precision is not None or within (0,6).

pub fn as_time_interval(&self) -> Self

Returns a new Interval with only the time component

pub fn is_negative(&self) -> bool

Returns true if combining all fields results in a negative number, false otherwise

pub fn convert_date_time_unit<T>( source: DateTimeField, dest: DateTimeField, val: T, ) -> Option<T>

where T: From<u16> + CheckedMul + DivAssign,

Convert val from source unit to dest unit. Does not maintain fractional values. Returns None if the result overflows/underflows.

WARNING: Due to the fact that Intervals consider months to have 30 days, you may get unexpected and incorrect results when trying to convert from a non-year type to a year type and vice versa. For example from years to days.

fn convert_date_time_unit_increasing<T>( source: DateTimeField, dest: DateTimeField, val: T, ) -> Option<T>

where T: From<u16> + DivAssign,

fn convert_date_time_unit_decreasing<T>( source: DateTimeField, dest: DateTimeField, val: T, ) -> Option<T>

where T: From<u16> + CheckedMul,

pub fn justify_days(&self) -> Result<Self, Error>

Adjust interval so ‘days’ contains less than 30 days, adding the excess to ‘months’.

fn justify_days_inner(months: i32, days: i32) -> Result<(i32, i32), Error>

pub fn justify_hours(&self) -> Result<Self, Error>

Adjust interval so ‘micros’ contains less than a whole day, adding the excess to ‘days’.

fn justify_hours_inner(days: i32, micros: i64) -> Result<(i32, i64), Error>

pub fn justify_interval(&self) -> Result<Self, Error>

Adjust interval so ‘days’ contains less than 30 days, adding the excess to ‘months’. Adjust interval so ‘micros’ contains less than a whole day, adding the excess to ‘days’. Also, the sign bit on all three fields is made equal, so either all three fields are negative or all are positive.

Trait Implementations

impl Arbitrary for Interval

type Strategy = BoxedStrategy<Interval>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<'a> AsColumnType for Interval

fn as_column_type() -> ColumnType

The SQL column type of this Rust type

impl CheckedNeg for Interval

fn checked_neg(&self) -> Option<Self>

Negates a number, returning None for results that can’t be represented, like signed MIN values that can’t be positive, or non-zero unsigned values that can’t be negative.

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColumnarStatsBuilder<Interval> for IntervalStatsBuilder

type ArrowColumn = FixedSizeBinaryArray

Type of arrow column these statistics can be derived from.

type FinishedStats = BytesStats

The type of statistics the collector finalizes into.

fn from_column(col: &Self::ArrowColumn) -> Self

where Self: Sized,

Derive statistics from a column of data.

fn finish(self) -> Self::FinishedStats

where Self::FinishedStats: Sized,

Finish this collector returning the final aggregated statistics.

fn from_column_dyn(col: &dyn Array) -> Option<Self>

where Self: Sized,

Derive statistics from an opaque column of data.

impl<'a, E> DatumType<'a, E> for Interval

fn nullable() -> bool

Whether this Rust type can represent NULL values

fn fallible() -> bool

Whether this Rust type can represent errors

fn try_from_result( res: Result<Datum<'a>, E>, ) -> Result<Self, Result<Datum<'a>, E>>

Try to convert a Result whose Ok variant is a Datum into this native Rust type (Self). If it fails the error variant will contain the original result.

fn into_result(self, _temp_storage: &'a RowArena) -> Result<Datum<'a>, E>

Convert this Rust type into a Result containing a Datum, or an error

impl Debug for Interval

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

Formats the value using the given formatter.

impl Default for Interval

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Interval

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Interval

Format an interval in a human form

Example outputs:

• 1 year 2 months 5 days 03:04:00
• -1 year +5 days +18:59:29.3
• 00:00:00

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

Formats the value using the given formatter.

impl FixedSizeCodec<Interval> for PackedInterval

const SIZE: usize = 16usize

Number of bytes the encoded format requires.

fn as_bytes(&self) -> &[u8]

Returns the encoded bytes as a slice.

fn from_bytes(slice: &[u8]) -> Result<Self, String>

Create an instance of self from a slice.

fn from_value(value: Interval) -> Self

Encode a type of T into this format.

fn into_value(self) -> Interval

Decode an instance of T from this format.

impl<'a> From<Interval> for Datum<'a>

fn from(other: Interval) -> Datum<'a>

Converts to this type from the input type.

impl FromStr for Interval

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Interval

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 Ord for Interval

fn cmp(&self, other: &Interval) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Interval

fn eq(&self, other: &Interval) -> 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 Interval

fn partial_cmp(&self, other: &Interval) -> 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 RustType<ProtoInterval> for Interval

fn into_proto(&self) -> ProtoInterval

Convert a Self into a Proto value.

fn from_proto(proto: ProtoInterval) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for Interval

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Datum<'_>> for Interval

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Interval

impl Eq for Interval

impl StructuralPartialEq for Interval