Struct TimeDuration 

pub struct TimeDuration { /* private fields */ }

A span or delta in time, measured in microseconds.

Analogous to std::time::Duration, and to C#’s TimeSpan. Name chosen to avoid ambiguity with either of those types.

Unlike Duration, but like C#’s TimeSpan, TimeDuration can represent negative values. It also offers less range than Duration, so conversions in both directions may fail.

Implementations

impl TimeDuration

pub const ZERO: TimeDuration

pub fn to_micros(self) -> i64

Get the number of microseconds self represents.

pub fn from_micros(micros: i64) -> TimeDuration

Construct a TimeDuration which is micros microseconds.

pub fn to_duration(self) -> Result<Duration, Duration>

Returns Err(abs(self) as Duration) if self is negative.

pub fn to_duration_abs(self) -> Duration

Returns a Duration representing the absolute magnitude of self.

Regardless of whether self is positive or negative, the returned Duration is positive.

pub fn abs(self) -> TimeDuration

Returns a positive TimeDuration with the magnitude of self.

pub fn from_duration(duration: Duration) -> TimeDuration

Return a TimeDuration which represents the same span as duration.

Panics if duration.as_micros overflows an i64

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

Returns Some(self + other), or None if that value would be out of bounds for TimeDuration.

pub fn checked_sub(self, other: TimeDuration) -> Option<TimeDuration>

Returns Some(self - other), or None if that value would be out of bounds for TimeDuration.

pub fn to_iso8601(self) -> String

Generate an iso8601 format string.

This is the better supported format for use for the pg wire protocol.

Example:

use std::time::Duration;
use spacetimedb_sats::time_duration::TimeDuration;
assert_eq!( TimeDuration::from_micros(0).to_iso8601().as_str(), "P0D");
assert_eq!( TimeDuration::from_micros(-1_000_000).to_iso8601().as_str(), "-PT1S");
assert_eq!( TimeDuration::from_duration(Duration::from_secs(60 * 24)).to_iso8601().as_str(), "PT1440S");

Trait Implementations

impl Add<TimeDuration> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, other: TimeDuration) -> <Timestamp as Add<TimeDuration>>::Output

Performs the + operation.

impl Add for TimeDuration

type Output = TimeDuration

The resulting type after applying the + operator.

fn add(self, rhs: TimeDuration) -> <TimeDuration as Add>::Output

Performs the + operation.

impl AddAssign<TimeDuration> for Timestamp

fn add_assign(&mut self, other: TimeDuration)

Performs the += operation.

impl AddAssign for TimeDuration

fn add_assign(&mut self, rhs: TimeDuration)

Performs the += operation.

impl Clone for TimeDuration

fn clone(&self) -> TimeDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeDuration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeDuration

fn deserialize<D>( deserializer: D, ) -> Result<TimeDuration, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given deserializer.

impl Display for TimeDuration

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

Formats the value using the given formatter.

impl From<Duration> for TimeDuration

fn from(d: Duration) -> TimeDuration

Converts to this type from the input type.

impl From<TimeDuration> for AlgebraicValue

fn from(value: TimeDuration) -> AlgebraicValue

Converts to this type from the input type.

impl From<TimeDuration> for ScheduleAt

fn from(value: TimeDuration) -> Self

Converts to this type from the input type.

impl GroundSpacetimeType for TimeDuration

fn get_type() -> AlgebraicType

Returns the AlgebraicType representation of Self.

impl Hash for TimeDuration

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

where __H: Hasher,

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 TimeDuration

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

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

fn partial_cmp(&self, other: &TimeDuration) -> 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 Serialize for TimeDuration

fn serialize<S>( &self, __serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize self in the data format of S using the provided serializer.

impl SpacetimeType for TimeDuration

fn make_type<S>(_ts: &mut S) -> AlgebraicType

where S: TypespaceBuilder,

Returns an AlgebraicType representing the type for Self in SATS and in the typing context in typespace. This is used by the automatic type registration system in Rust modules.

impl Sub<TimeDuration> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, other: TimeDuration) -> <Timestamp as Sub<TimeDuration>>::Output

Performs the - operation.

impl Sub for TimeDuration

type Output = TimeDuration

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDuration) -> <TimeDuration as Sub>::Output

Performs the - operation.

impl SubAssign<TimeDuration> for Timestamp

fn sub_assign(&mut self, rhs: TimeDuration)

Performs the -= operation.

impl SubAssign for TimeDuration

fn sub_assign(&mut self, rhs: TimeDuration)

Performs the -= operation.

impl Copy for TimeDuration

impl Eq for TimeDuration

impl StructuralPartialEq for TimeDuration