Struct DeviceClient 

pub struct DeviceClient<C>
where
    C: Connection,
{ /* private fields */ }

Client to send and receive message to and form Astarte or access the Device properties.

Notes

Cloning the client will not broadcast the DeviceEvent. Each message can only be received once.

Implementations

impl<S> DeviceClient<Mqtt<S>>

where S: StoreCapabilities,

pub async fn get_cert_expiry(&self) -> Option<DateTime<Utc>>

Retrieve the expiry (not_after) timestamp of the current certificate

pub async fn is_valid_at(&self, check_dt: DateTime<Utc>) -> Option<bool>

Retrieve the expiry (not_after) timestamp of the current certificate Note that this function will log a security event if the feature is enabled when the certificate will expire at the passed datetime

Trait Implementations

impl<C> Client for DeviceClient<C>

where C: Connection, C::Sender: Publish,

async fn send_object_with_timestamp( &mut self, interface_name: &str, base_path: &str, data: AstarteObject, timestamp: DateTime<Utc>, ) -> Result<(), Error>

Send an object datastream on an interface, with an explicit timestamp.

async fn send_object( &mut self, interface_name: &str, base_path: &str, data: AstarteObject, ) -> Result<(), Error>

Send an object datastream on an interface.

async fn send_individual( &mut self, interface_name: &str, mapping_path: &str, data: AstarteData, ) -> Result<(), Error>

Send an individual datastream on an interface.

async fn send_individual_with_timestamp( &mut self, interface_name: &str, mapping_path: &str, data: AstarteData, timestamp: DateTime<Utc>, ) -> Result<(), Error>

Send an individual datastream on an interface, with an explicit timestamp.

async fn set_property( &mut self, interface_name: &str, mapping_path: &str, data: AstarteData, ) -> Result<(), Error>

Send an individual datastream on an interface.

async fn unset_property( &mut self, interface_name: &str, mapping_path: &str, ) -> Result<(), Error>

Unset a device property.

async fn recv(&self) -> Result<DeviceEvent, RecvError>

Receives an event from Astarte.

impl<C> ClientDisconnect for DeviceClient<C>

where C: Connection, C::Sender: Disconnect,

async fn disconnect(&mut self) -> Result<(), Error>

Cleanly disconnects the client consuming it.

impl<C> Clone for DeviceClient<C>

where C: Connection,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for DeviceClient<C>

where C: Connection + Debug, C::Sender: Debug, C::Store: Debug,

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

Formats the value using the given formatter.

impl<C> DeviceIntrospection for DeviceClient<C>

where C: Connection,

async fn get_interface<F, O>(&self, interface_name: &str, f: F) -> O

where F: FnMut(Option<&Interface>) -> O + Send,

Returns a reference to the Interface with the given name.

impl<C> DynamicIntrospection for DeviceClient<C>

where C: Connection, C::Sender: Register,

async fn add_interface(&mut self, interface: Interface) -> Result<bool, Error>

Add a new Interface to the device introspection.

async fn extend_interfaces<I>(&mut self, iter: I) -> Result<Vec<String>, Error>

where I: IntoIterator<Item = Interface> + Send,

Add one or more Interface to the device introspection.

async fn add_interface_from_file<P>( &mut self, file_path: P, ) -> Result<bool, Error>

where P: AsRef<Path> + Send + Sync,

Add a new interface from the provided file.

async fn add_interface_from_str( &mut self, json_str: &str, ) -> Result<bool, Error>

Add a new interface from a string. The string should contain a valid json formatted interface.

async fn remove_interface( &mut self, interface_name: &str, ) -> Result<bool, Error>

Remove the interface with the name specified as argument.

async fn remove_interfaces<I>( &mut self, interfaces_name: I, ) -> Result<Vec<String>, Error>

where I: IntoIterator<Item = String> + Send, I::IntoIter: Send,

Remove interfaces with names specified as argument.

impl<C> PropAccess for DeviceClient<C>

where C: Connection,

async fn property( &self, interface_name: &str, path: &str, ) -> Result<Option<AstarteData>, Error>

Get the value of a property given the interface and path.

async fn interface_props( &self, interface_name: &str, ) -> Result<Vec<StoredProp>, Error>

Get all the properties of the given interface.

async fn all_props(&self) -> Result<Vec<StoredProp>, Error>

Get all the stored properties, device or server owners.

async fn device_props(&self) -> Result<Vec<StoredProp>, Error>

Get all the stored device properties.

async fn server_props(&self) -> Result<Vec<StoredProp>, Error>

Get all the stored server properties.