Struct Map 

pub struct Map<S, F> { /* private fields */ }

A sensor whose readings pass through a function before they are returned.

Created by Sensor::map. The function runs on every read, so it can select one channel of a multi-channel measurement, convert a unit, or fold several fields into one value.

Examples

use pamoja_core::{Result, Sensor};

struct Climate;
impl Sensor for Climate {
    type Reading = (f32, f32);
    async fn read(&mut self) -> Result<(f32, f32)> {
        Ok((21.5, 48.0))
    }
}

let mut humidity = Climate.map(|(_, humidity)| humidity);
assert_eq!(humidity.read().await?, 48.0);

Implementations

impl<S, F> Map<S, F>

pub fn new(inner: S, select: F) -> Map<S, F>

Wraps inner so each reading passes through select.

Arguments

• inner - the sensor being adapted.
• select - the function applied to each reading.

Returns

The adapted sensor.

pub fn inner(&self) -> &S

Borrows the wrapped sensor.

Returns

The sensor underneath the adapter.

pub fn inner_mut(&mut self) -> &mut S

Mutably borrows the wrapped sensor.

Returns

The sensor underneath the adapter.

pub fn into_inner(self) -> S

Unwraps the sensor, discarding the adapter.

Returns

The sensor underneath the adapter.

Trait Implementations

impl<S, F, T> Sensor for Map<S, F>

where S: Sensor + Send, F: FnMut(S::Reading) -> T + Send,

type Reading = T

The value produced by a single read, for example a temperature or a fix.

async fn read(&mut self) -> Result<T>

Takes a single reading from the sensor.

fn map<F, T>(self, select: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Reading) -> T,

Wraps this sensor so every reading passes through select first.