Struct TimestampDuration 

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

8-byte-aligned u64 newtype that serializes as a string for JSON safety.

Implementations

impl TimestampDuration

pub const fn new(v: u64) -> Self

Wraps a raw u64.

pub const fn as_u64(self) -> u64

Returns the underlying u64.

impl TimestampDuration

pub const fn new_secs(secs: u32) -> Self

Make a duration from a number of seconds.

pub const fn new_ms(ms: u64) -> Self

Make a duration from a number of milliseconds.

pub fn is_zero(&self) -> bool

Returns true if the duration is zero.

pub fn since(older: Timestamp) -> Self

Elapsed time from older to now, saturating to zero if older is in the future.

pub fn since_non_decreasing(older: Timestamp) -> Self

Elapsed time from older to a non-decreasing now, saturating to zero if older is in the future.

pub fn seconds_u32(&self) -> Result<u32, String>

Whole seconds as a u32, erroring if the value overflows.

pub fn millis_u32(&self) -> Result<u32, String>

Whole milliseconds as a u32, erroring if the value overflows.

pub fn seconds_f64(&self) -> f64

Seconds as an f64, trading off least significant bits for range.

pub const fn saturating_add(self, rhs: Self) -> Self

Add two durations, saturating at the maximum value.

pub const fn saturating_sub(self, rhs: Self) -> Self

Subtract a duration, saturating at zero.

pub const fn saturating_mul(self, rhs: u64) -> Self

Multiply by a scalar, saturating at the maximum value.

pub fn f64_mul(self, rhs: f64) -> Self

Multiply by an f64 scaling factor (not const due to float arithmetic)

pub const fn div(self, rhs: u64) -> Self

Divide by a scalar.

pub const fn div_assign(&mut self, rhs: u64)

Divide by a scalar in place.

pub fn checked_div<T: Into<u64>>(self, rhs: T) -> Option<Self>

Divide by a scalar, returning None on divide by zero.

pub fn checked_mul<T: Into<u64>>(self, rhs: T) -> Option<Self>

Multiply by a scalar, returning None on overflow.

pub const fn saturating_add_assign(&mut self, rhs: Self)

Add a duration in place, saturating at the maximum value.

pub const fn saturating_sub_assign(&mut self, rhs: Self)

Subtract a duration in place, saturating at zero.

pub const fn saturating_mul_assign(&mut self, rhs: u64)

Multiply by a scalar in place, saturating at the maximum value.

pub fn timeout<F, T>( self, f: F, ) -> impl Future<Output = Result<T, TimeoutError>>

where F: Future<Output = T>,

Wrap a future with a timeout based on this duration. Saturates to u32::MAX milliseconds (~49.7 days) on overflow.

pub fn interval<F, FUT>( self, name: &str, immediate: bool, callback: F, ) -> PinBoxFutureStatic<()>

where F: Fn() -> FUT + Send + Sync + 'static, FUT: Future<Output = ()> + Send,

Run a periodic callback at this duration’s interval. Saturates to u32::MAX milliseconds (~49.7 days) on overflow.

Trait Implementations

impl Clone for TimestampDuration

fn clone(&self) -> TimestampDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimestampDuration

impl Debug for TimestampDuration

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

Formats the value using the given formatter.

impl Default for TimestampDuration

fn default() -> TimestampDuration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimestampDuration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimestampDuration

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

Formats the value using the given formatter.

impl Eq for TimestampDuration

impl From<TimestampDuration> for u64

fn from(v: TimestampDuration) -> Self

Converts to this type from the input type.

impl From<u64> for TimestampDuration

fn from(v: u64) -> Self

Converts to this type from the input type.

impl FromStr for TimestampDuration

type Err = <u64 as FromStr>::Err

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 GetSize for TimestampDuration

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for TimestampDuration

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 TimestampDuration

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TimestampDuration

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimestampDuration

impl ToVeilidAPIErrorArgument for TimestampDuration

fn to_veilid_api_error_argument(&self) -> String

Render this value as a string for inclusion in a VeilidAPIError message field.