Struct Timedelta 

pub struct Timedelta(/* private fields */);

A signed span of nanoseconds: how far apart two points on one timeline are.

Its operators saturate at MIN and MAX, about 292 years either way, and each has a checked_* twin. It is written coarsest unit first, the way a config spells it, and parses back from the same spelling.

Examples

use t2t_core::Timedelta;

let budget = Timedelta::from_millis(250);
assert_eq!(budget.as_micros(), 250_000, "the same span, counted finer");
assert_eq!(budget.to_string(), "250ms", "written in its coarsest unit");
assert_eq!("1m0s250ms".parse(), Ok(Timedelta::MINUTE + budget), "and read back");

Implementations

impl Timedelta

pub const ZERO: Self

No time at all.

pub const MIN: Self

The longest span backwards.

pub const MAX: Self

The longest span.

pub const fn is_zero(self) -> bool

Whether the span is zero.

pub const fn is_negative(self) -> bool

Whether the span runs backwards.

pub const fn is_positive(self) -> bool

Whether the span runs forwards.

pub const fn abs(self) -> Self

The span forwards, MAX for MIN.

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

The sum, or None past the range.

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

The difference, or None past the range.

pub const fn checked_mul(self, factor: i64) -> Option<Self>

The span factor times over, or None past the range.

pub const fn checked_div(self, parts: i64) -> Option<Self>

One of parts equal parts, truncated toward zero, or None for no parts, or for MIN in -1.

pub const fn checked_neg(self) -> Option<Self>

The span backwards, or None for MIN.

pub const fn checked_abs(self) -> Option<Self>

The span forwards, or None for MIN.

pub const fn floor(self, unit: Self) -> Self

The nearest multiple of |unit| at or below the span, or the span for a zero unit.

pub const fn ceil(self, unit: Self) -> Self

The nearest multiple of |unit| at or above the span, or the span for a zero unit.

impl Timedelta

pub const NANOSECOND: Self

One nanosecond, the finest span the count resolves.

pub const MICROSECOND: Self

One microsecond.

pub const MILLISECOND: Self

One millisecond.

pub const SECOND: Self

One second.

pub const MINUTE: Self

One minute.

pub const HOUR: Self

One hour.

pub const DAY: Self

One day of 24 hours; no calendar is consulted.

pub const fn from_nanos(nanos: i64) -> Self

A span of nanos nanoseconds.

pub const fn as_nanos(self) -> i64

The span in nanoseconds.

pub const fn from_micros(micros: i64) -> Self

A span of micros microseconds, saturating.

pub const fn from_millis(millis: i64) -> Self

A span of millis milliseconds, saturating.

pub const fn from_secs(secs: i64) -> Self

A span of secs seconds, saturating.

pub const fn from_mins(mins: i64) -> Self

A span of mins minutes, saturating.

pub const fn from_hours(hours: i64) -> Self

A span of hours hours, saturating.

pub const fn from_days(days: i64) -> Self

A span of days days of 24 hours, saturating.

pub const fn as_micros(self) -> i64

The span in whole microseconds, truncated toward zero.

pub const fn as_millis(self) -> i64

The span in whole milliseconds, truncated toward zero.

pub const fn as_secs(self) -> i64

The span in whole seconds, truncated toward zero.

pub const fn as_mins(self) -> i64

The span in whole minutes, truncated toward zero.

pub const fn as_hours(self) -> i64

The span in whole hours, truncated toward zero.

pub const fn as_days(self) -> i64

The span in whole days of 24 hours, truncated toward zero.

pub const fn subsec_nanos(self) -> i32

The nanoseconds past the whole seconds, signed as the span is.

pub const fn subsec_micros(self) -> i32

The whole microseconds past the whole seconds, signed as the span is.

pub const fn subsec_millis(self) -> i32

The whole milliseconds past the whole seconds, signed as the span is.

pub const fn to_tickdelta(self, rate: TickRate) -> Tickdelta

How many ticks the span lasts at rate: a multiply and a shift, to within a tick.

Trait Implementations

impl Add for Timedelta

Saturates at MIN and MAX.

type Output = Timedelta

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Timedelta> for Timestamp

Saturates at MIN and MAX.

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, span: Timedelta) -> Self

Performs the + operation.

impl Add<Timedelta> for TaiTimestamp

Saturates at MIN and MAX.

type Output = TaiTimestamp

The resulting type after applying the + operator.

fn add(self, span: Timedelta) -> Self

Performs the + operation.

impl Add<Timedelta> for Uptime

Saturates at MIN and MAX.

type Output = Uptime

The resulting type after applying the + operator.

fn add(self, span: Timedelta) -> Self

Performs the + operation.

impl Add<Timedelta> for RawUptime

Saturates at MIN and MAX.

type Output = RawUptime

The resulting type after applying the + operator.

fn add(self, span: Timedelta) -> Self

Performs the + operation.

impl Add<Timedelta> for BootUptime

Saturates at MIN and MAX.

type Output = BootUptime

The resulting type after applying the + operator.

fn add(self, span: Timedelta) -> Self

Performs the + operation.

impl AddAssign for Timedelta

Saturates at MIN and MAX.

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign<Timedelta> for Timestamp

Saturates at MIN and MAX.

fn add_assign(&mut self, span: Timedelta)

Performs the += operation.

impl AddAssign<Timedelta> for TaiTimestamp

Saturates at MIN and MAX.

fn add_assign(&mut self, span: Timedelta)

Performs the += operation.

impl AddAssign<Timedelta> for Uptime

Saturates at MIN and MAX.

fn add_assign(&mut self, span: Timedelta)

Performs the += operation.

impl AddAssign<Timedelta> for RawUptime

Saturates at MIN and MAX.

fn add_assign(&mut self, span: Timedelta)

Performs the += operation.

impl AddAssign<Timedelta> for BootUptime

Saturates at MIN and MAX.

fn add_assign(&mut self, span: Timedelta)

Performs the += operation.

impl Clone for Timedelta

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timedelta

impl Debug for Timedelta

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

Formats the value using the given formatter.

impl Default for Timedelta

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Timedelta

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for Timedelta

Coarsest unit first, once each, 0s for zero: 1d2h, 1m0s250ms, -3us.

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

Formats the value using the given formatter.

impl Eq for Timedelta

impl From<Timedelta> for TimeDelta

Available on crate feature chrono-04 only.

Every span, since a TimeDelta holds every i64 of nanoseconds.

fn from(span: Timedelta) -> Self

Converts to this type from the input type.

impl From<Timedelta> for SignedDuration

Available on crate feature jiff-02 only.

Every span, since a SignedDuration holds every i64 of nanoseconds.

fn from(span: Timedelta) -> Self

Converts to this type from the input type.

impl From<Timedelta> for Duration

Available on crate feature time-03 only.

Every span, since a Duration holds every i64 of nanoseconds.

fn from(span: Timedelta) -> Self

Converts to this type from the input type.

impl FromBytes for Timedelta

where i64: FromBytes,

Available on crate feature zerocopy only.

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, !>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, !>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, !>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, !>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, !>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, !>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

fn read_from_io<R>(src: R) -> Result<Self, Error>

where Self: Sized, R: Read,

Available on crate feature std only.

Reads a copy of self from an io::Read.

impl FromStr for Timedelta

Reads what Display writes, and the bare 0: each unit at most once and coarsest first, with any count in each, so 48h reads as the span 2d spells.

type Err = ParseTimedeltaError

The associated error which can be returned from parsing.

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

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

impl FromZeros for Timedelta

where i64: FromZeros,

Available on crate feature zerocopy only.

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Available on crate features alloc only.

Creates a Box<Self> from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Result<Vec<Self>, AllocError>

where Self: Sized,

Available on crate feature alloc only.

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Available on crate feature alloc and non-no_zerocopy_panic_in_const_and_vec_try_reserve_1_57_0 only.

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Available on crate feature alloc and non-no_zerocopy_panic_in_const_and_vec_try_reserve_1_57_0 only.

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl Hash for Timedelta

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 Immutable for Timedelta

where i64: Immutable,

Available on crate feature zerocopy only.

impl IntoBytes for Timedelta

where i64: IntoBytes,

Available on crate feature zerocopy only.

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

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

fn write_to_io<W>(&self, dst: W) -> Result<(), Error>

where Self: Immutable, W: Write,

Available on crate feature std only.

Writes a copy of self to an io::Write.

impl JsonSchema for Timedelta

Available on crate features schemars and serde only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl KnownLayout for Timedelta

where Self: Sized,

Available on crate feature zerocopy only.

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl Mul<Timedelta> for i64

Saturates at the span’s range.

type Output = Timedelta

The resulting type after applying the * operator.

fn mul(self, span: Timedelta) -> Timedelta

Performs the * operation.

impl Mul<i64> for Timedelta

Saturates at MIN and MAX.

type Output = Timedelta

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i64> for Timedelta

Saturates at MIN and MAX.

fn mul_assign(&mut self, factor: i64)

Performs the *= operation.

impl Neg for Timedelta

MAX for MIN.

type Output = Timedelta

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Timedelta

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Timedelta

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Timedelta

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 Serialize for Timedelta

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Timedelta

impl Sub for Timedelta

Saturates at MIN and MAX.

type Output = Timedelta

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Timedelta> for Timestamp

Saturates at MIN and MAX.

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, span: Timedelta) -> Self

Performs the - operation.

impl Sub<Timedelta> for TaiTimestamp

Saturates at MIN and MAX.

type Output = TaiTimestamp

The resulting type after applying the - operator.

fn sub(self, span: Timedelta) -> Self

Performs the - operation.

impl Sub<Timedelta> for Uptime

Saturates at MIN and MAX.

type Output = Uptime

The resulting type after applying the - operator.

fn sub(self, span: Timedelta) -> Self

Performs the - operation.

impl Sub<Timedelta> for RawUptime

Saturates at MIN and MAX.

type Output = RawUptime

The resulting type after applying the - operator.

fn sub(self, span: Timedelta) -> Self

Performs the - operation.

impl Sub<Timedelta> for BootUptime

Saturates at MIN and MAX.

type Output = BootUptime

The resulting type after applying the - operator.

fn sub(self, span: Timedelta) -> Self

Performs the - operation.

impl SubAssign for Timedelta

Saturates at MIN and MAX.

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign<Timedelta> for Timestamp

Saturates at MIN and MAX.

fn sub_assign(&mut self, span: Timedelta)

Performs the -= operation.

impl SubAssign<Timedelta> for TaiTimestamp

Saturates at MIN and MAX.

fn sub_assign(&mut self, span: Timedelta)

Performs the -= operation.

impl SubAssign<Timedelta> for Uptime

Saturates at MIN and MAX.

fn sub_assign(&mut self, span: Timedelta)

Performs the -= operation.

impl SubAssign<Timedelta> for RawUptime

Saturates at MIN and MAX.

fn sub_assign(&mut self, span: Timedelta)

Performs the -= operation.

impl SubAssign<Timedelta> for BootUptime

Saturates at MIN and MAX.

fn sub_assign(&mut self, span: Timedelta)

Performs the -= operation.

impl Sum for Timedelta

Saturates at MIN and MAX.

fn sum<I: Iterator<Item = Self>>(spans: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a Timedelta> for Timedelta

Saturates at MIN and MAX.

fn sum<I: Iterator<Item = &'a Self>>(spans: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Duration> for Timedelta

Refuses a duration past Timedelta::MAX.

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(duration: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SignedDuration> for Timedelta

Available on crate feature jiff-02 only.

Refuses a duration past Timedelta::MIN or Timedelta::MAX.

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(duration: SignedDuration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SignedDuration> for Timedelta

Available on crate feature time-03 only.

Refuses a duration past Timedelta::MIN or Timedelta::MAX.

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(duration: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TimeDelta> for Timedelta

Available on crate feature chrono-04 only.

Refuses a duration past Timedelta::MIN or Timedelta::MAX.

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(span: TimeDelta) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Timedelta> for Duration

Refuses a negative span.

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(span: Timedelta) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromBytes for Timedelta

where i64: TryFromBytes,

Available on crate feature zerocopy only.

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.