Skip to main content

Sample

Struct Sample 

Source
pub struct Sample {
    pub metric: String,
    pub at: Timestamp,
    pub value: f64,
    pub kind: Kind,
}
Expand description

One measurement of one metric at one instant.

Build one with Sample::new, which refuses a non-finite value. The fields are public, so a caller can also write a Sample literal directly; in that case the finite-value check is the caller’s to have done.

Fields§

§metric: String

The metric this sample belongs to.

§at: Timestamp

Seconds since the Unix epoch.

§value: f64

The measured value.

§kind: Kind

How this sample aggregates.

Implementations§

Source§

impl Sample

Source

pub fn new( metric: impl Into<String>, at: Timestamp, value: f64, kind: Kind, ) -> Option<Self>

One sample. Refuses a non-finite value.

use interval_align::{Kind, Sample};

let sample = Sample::new("hall.kw", 1_772_949_600, 100.0, Kind::Power);
assert!(sample.is_some());
assert!(Sample::new("hall.kw", 1_772_949_600, f64::NAN, Kind::Power).is_none());

Trait Implementations§

Source§

impl Clone for Sample

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sample

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Sample

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Sample

Auto Trait Implementations§

§

impl Forget for Sample

§

impl Freeze for Sample

§

impl Move for Sample

§

impl RefUnwindSafe for Sample

§

impl Send for Sample

§

impl Sync for Sample

§

impl Unpin for Sample

§

impl UnsafeUnpin for Sample

§

impl UnwindSafe for Sample

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.