Struct drmem_api::client::RequestChan

pub struct RequestChan { /* private fields */ }

A handle which is used to communicate with the core of DrMem. Clients will be given a handle to be used throughout its life.

This type wraps the mpsc::Sender<> and defines a set of helper methods to send requests and receive replies with the core.

Implementations

impl RequestChan

pub fn new(req_chan: Sender<Request>) -> Self

pub async fn monitor_device( &self, name: Name, start: Option<DateTime<Utc>>, end: Option<DateTime<Utc>> ) -> Result<DataStream<Reading>>

Makes a request to monitor the device, name.

If sucessful, a stream is returned which yields device readings as the device is updated.

pub async fn set_device<T: Into<Value> + TryFrom<Value, Error = Error>>( &self, name: Name, value: T ) -> Result<T>

Requests that a device be set to a provided value.

• name is the name of the device
• value is the value to be set. This value can be a device::Value value or can be any type that can be coerced into one.

Returns the value the driver actually used to set the device. Some drivers do sanity checks on the set value and, if the value is unusable, the driver may return an error or clip the value to something valid. The driver’s documentation should indicate how it handles invalid settings.

pub async fn get_setting_chan( &self, name: Name, own: bool ) -> Result<TxDeviceSetting>

pub async fn get_device_info( &self, pattern: Option<String> ) -> Result<Vec<DevInfoReply>>

Requests device information for devices whose name matches the provided pattern.

Trait Implementations

impl Clone for RequestChan

fn clone(&self) -> RequestChan

Returns a copy of the value.

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

Performs copy-assignment from source.