Struct Sample 

pub struct Sample<T> {
    pub value: T,
    pub provenance: Provenance,
    pub freshness: Freshness,
    pub envelope: Envelope,
}

A signal value with its provenance, its freshness and its envelope.

Fields

value: T

The value. Never absent: the init value under Init, and the last good value or the init value under Invalid.

provenance: Provenance

Where the value comes from.

freshness: Freshness

How old the value is.

envelope: Envelope

The sender’s timestamp and sequence number.

Implementations

impl<T> Sample<T>

pub fn usable(&self) -> bool

true when the provenance is Live and the freshness is not Stale.

Examples found in repository

examples/read_sample.rs (line 374)

fn main() {
    let steps = [
        "init",
        "live",
        "stale",
        "declared invalid",
        "detected invalid",
        "corrupt",
    ];
    for (step, sample) in steps.iter().zip(walk()) {
        println!("{step}: {sample:?} usable={}", sample.usable());
    }
}

Trait Implementations

impl<T: Clone> Clone for Sample<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Sample<T>

impl<T: Debug> Debug for Sample<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Sample<T>

impl<T: PartialEq> PartialEq for Sample<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Sample<T>