Struct iot_device_bridge::device_shadow::DeviceShadow

pub struct DeviceShadow { /* private fields */ }

DeviceShadow holds the attributes for handling a shadow

• shadow_value : JSON values of the shadow
• eventloop_handle : handle for communocating with the cloud shadow
• shadow_topic : ShadowTopic

Implementations

impl DeviceShadow

pub fn new(
    thing_name: String,
    shadow_type: ShadowType,
    eventloop_handle: Sender<Request>
) -> Self

pub fn get_name(&self) -> String

Get Device Shadow prefix, e.g., AWS specific

pub fn get_prefix(&self) -> String

Get Device Shadow prefix, e.g., AWS specific

pub fn get_shadow_topic(&self) -> ShadowTopic

Get Device Shadow topic, e.g., AWS specific.

pub fn get_shadow_name_from_aws_topic(&self, aws_topic: &String) -> String

Get Shadow Name from topic, e.g., “$aws/things/{}/shadow/name/{}/”

pub fn build_shadow_message_update(
    &self,
    shadow_value: String,
    reported_only: bool
) -> IotMessage

Builds either UPDATE reported or UPDATE desired-and-reported Iot Message

pub async fn retrieve_shadow_delivery(
    &mut self,
    event: &Publish
) -> Result<(&str, Value), IoTError>

The retrieve_shadow_delivery function

1. performs actions on the general DeviceShadow
2. stores the delivered payload
3. returns following sub-branch to be processed by device specific function
   a. Response UPDATE_ACCEPTED: state.desired.* b. Response UPDATE_DELTA: state.* c. Response UPDATE_DOCUMENTS: current.state.desired.* d. Response GET_ACCEPTED: state.desired.* e. all other responses return serde_json::Value::Null Remark: The device specific processing of the “documents”, “delta” and “update” shadow responses (particularly containing incremental changes only) will be done in the Device Adapter.

pub async fn initiate_shadow(
    &self,
    eventloop: &mut EventLoop,
    xmit: Xmit<IotMessage>,
    shadow_initial_update: String
) -> Result<(), IoTError>

Helper function to

• subscribe to all prefixes of a DeviceShadow and
• initiate GET of the remote shadow by sending the message to the IoT sender via MPSC channel

Trait Implementations

impl Debug for DeviceShadow

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

Formats the value using the given formatter.