Struct Sample 

pub struct Sample { /* private fields */ }

Available on crate feature sensors only.

Represents a value obtained from a sensor device, along with its metadata.

Scaling

The scaling value obtained from the sensor driver with Sensor::reading_channels() must be taken into account using the following formula:

$$\mathtt{Sample::value()}·{10}^{\mathtt{scaling}}$$

For instance, in the case of a temperature sensor, if Self::value() returns 2225 and the scaling value is -2, this means that the temperature measured and returned by the sensor device is 22.25 (the measurement error must additionally be taken into account). This is required to avoid handling floats.

Unit of measurement

The unit of measurement can be obtained using ReadingChannel::unit().

Accuracy

The accuracy can be obtained through Self::metadata().

Implementations

impl Sample

pub const fn new(value: i32, metadata: SampleMetadata) -> Sample

Creates a new sample.

This constructor is intended for sensor driver implementors only.

pub fn value(&self) -> Result<i32, SampleError>

Returns the sample value.

Errors

SampleError is returned in case of error.

pub fn metadata(&self) -> SampleMetadata

Returns the measurement metadata, including accuracy if available.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Format for Sample

where SampleMetadata: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for Sample

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Sample

impl StructuralPartialEq for Sample