Struct Timed 

#[repr(C)]
pub struct Timed<T, S = Timestamp> {
    pub stamp: S,
    pub value: T,
}

A value T and the stamp S its writer captured it with.

The stamp comes from the writer: by the time a reader holds the value the moment has gone, and a clock read on the reading side would time the reader. The stamp comes first, so the derived order is chronological, and the value is reached through Deref.

Examples

use t2t_core::{Timed, Timedelta, Timestamp};

let captured = Timestamp::from_secs(1_700_000_000);
let sample = Timed::new(captured, 101_u64);

assert_eq!(*sample, 101, "the value, through `Deref`");
let now = captured + Timedelta::from_millis(5);
assert_eq!(sample.elapsed(now), Timedelta::from_millis(5), "its age");

Fields

stamp: S

When the value was captured.

value: T

What was captured.

Implementations

impl<T, S> Timed<T, S>

pub const fn new(stamp: S, value: T) -> Timed<T, S>

value, captured at stamp.

Examples found in repository

examples/time-tour.rs (line 43)

fn main() {
    // A span is written and read the way a config spells it.
    let stale = Timedelta::SECOND;
    println!("stale after        {stale}");
    println!("\"1h30m\" reads as   {:?}", "1h30m".parse::<Timedelta>());

    // An instant is a point; the difference of two is a span.
    let published = Timestamp::from_secs(1_700_000_000);
    let captured = published + Timedelta::from_micros(850);
    println!("published          {published}");
    println!("captured           {captured:.6}");
    println!("on the wire        {}", captured - published);

    // The same instant, read as a date; and the minute it falls in.
    let date_time = captured.to_utc();
    println!(
        "that is            {}-{:02}-{:02}, {} ns past the second",
        date_time.year, date_time.month, date_time.day, date_time.nanosecond
    );
    let minute = captured.floor(Timedelta::MINUTE);
    println!("its minute         {minute:.0} to {:.0}", minute + Timedelta::MINUTE);

    // A value carries the stamp its writer captured it with, and says how old it is.
    let sample = Timed::new(captured, Weather { celsius: 21, humidity: 40 });
    let age = sample.elapsed(captured + Timedelta::from_millis(1_500));
    println!(
        "sample             {} °C, {}%, {age} old, stale: {}",
        sample.celsius,
        sample.humidity,
        age > stale
    );

    // A counter's ticks mean nothing until a rate says what one is worth.
    let start = Tickstamp::from_ticks(1_000_000);
    let ticks = start + Tickdelta::from_ticks(4_250) - start;
    let rate = TickRate::GIGAHERTZ;
    println!("counter ran        {ticks}: {} at {rate}", ticks.to_timedelta(rate));
}

pub fn into_inner(self) -> T

The value, without its stamp.

pub fn into_parts(self) -> (S, T)

The stamp and the value.

pub fn map<U, F>(self, transform: F) -> Timed<U, S>

where F: FnOnce(T) -> U,

The same stamp over a value made from this one.

pub fn map_stamp<R, F>(self, transform: F) -> Timed<T, R>

where F: FnOnce(S) -> R,

The same value under a stamp made from this one.

impl<T, S> Timed<T, S>

where S: Copy,

pub const fn as_ref(&self) -> Timed<&T, S>

The same stamp over a borrow of the value.

pub const fn as_mut(&mut self) -> Timed<&mut T, S>

The same stamp over a mutable borrow of the value.

impl<T, S> Timed<T, S>

where S: TimePoint,

pub fn elapsed(&self, now: S) -> <S as TimePoint>::Span

The span from capture to now, negative for a stamp still ahead.

Examples found in repository

examples/time-tour.rs (line 44)

fn main() {
    // A span is written and read the way a config spells it.
    let stale = Timedelta::SECOND;
    println!("stale after        {stale}");
    println!("\"1h30m\" reads as   {:?}", "1h30m".parse::<Timedelta>());

    // An instant is a point; the difference of two is a span.
    let published = Timestamp::from_secs(1_700_000_000);
    let captured = published + Timedelta::from_micros(850);
    println!("published          {published}");
    println!("captured           {captured:.6}");
    println!("on the wire        {}", captured - published);

    // The same instant, read as a date; and the minute it falls in.
    let date_time = captured.to_utc();
    println!(
        "that is            {}-{:02}-{:02}, {} ns past the second",
        date_time.year, date_time.month, date_time.day, date_time.nanosecond
    );
    let minute = captured.floor(Timedelta::MINUTE);
    println!("its minute         {minute:.0} to {:.0}", minute + Timedelta::MINUTE);

    // A value carries the stamp its writer captured it with, and says how old it is.
    let sample = Timed::new(captured, Weather { celsius: 21, humidity: 40 });
    let age = sample.elapsed(captured + Timedelta::from_millis(1_500));
    println!(
        "sample             {} °C, {}%, {age} old, stale: {}",
        sample.celsius,
        sample.humidity,
        age > stale
    );

    // A counter's ticks mean nothing until a rate says what one is worth.
    let start = Tickstamp::from_ticks(1_000_000);
    let ticks = start + Tickdelta::from_ticks(4_250) - start;
    let rate = TickRate::GIGAHERTZ;
    println!("counter ran        {ticks}: {} at {rate}", ticks.to_timedelta(rate));
}

Trait Implementations

impl<T, S> Clone for Timed<T, S>

where T: Clone, S: Clone,

fn clone(&self) -> Timed<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, S> Copy for Timed<T, S>

where T: Copy, S: Copy,

impl<T, S> Debug for Timed<T, S>

where T: Debug, S: Debug,

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

Formats the value using the given formatter.

impl<T, S> Default for Timed<T, S>

where T: Default, S: Default,

fn default() -> Timed<T, S>

Returns the “default value” for a type.

impl<T, S> Deref for Timed<T, S>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Timed<T, S> as Deref>::Target

Dereferences the value.

impl<T, S> DerefMut for Timed<T, S>

fn deref_mut(&mut self) -> &mut <Timed<T, S> as Deref>::Target

Mutably dereferences the value.

impl<T, S> Eq for Timed<T, S>

where T: Eq, S: Eq,

impl<T, S> From<(S, T)> for Timed<T, S>

fn from(value: (S, T)) -> Timed<T, S>

Converts to this type from the input type.

impl<T, S> FromBytes for Timed<T, S>

where S: FromBytes, T: FromBytes,

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 ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, !>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

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

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

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

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

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

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

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<T, S> FromZeros for Timed<T, S>

where S: FromZeros, T: FromZeros,

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_box_zeroed_with_elems(count: usize) -> Result<Box<Self>, AllocError>

where Self: KnownLayout<PointerMetadata = usize>,

Available on crate feature alloc only.

Creates a Box<[Self]> (a boxed slice) 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<T, S> Hash for Timed<T, S>

where T: Hash, S: Hash,

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<T, S> Immutable for Timed<T, S>

where S: Immutable, T: Immutable,

impl<T, S> KnownLayout for Timed<T, S>

where T: KnownLayout,

type PointerMetadata = <T as KnownLayout>::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<T, S> Ord for Timed<T, S>

where T: Ord, S: Ord,

fn cmp(&self, other: &Timed<T, S>) -> 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<T, S> PartialEq for Timed<T, S>

where T: PartialEq, S: PartialEq,

fn eq(&self, other: &Timed<T, S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T, S> PartialOrd for Timed<T, S>

where T: PartialOrd, S: PartialOrd,

fn partial_cmp(&self, other: &Timed<T, S>) -> 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<T, S> StructuralPartialEq for Timed<T, S>

where T: PartialEq, S: PartialEq,

impl<T, S> TryFromBytes for Timed<T, S>

where S: TryFromBytes, T: TryFromBytes,

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_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

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

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

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.