Struct rustot::shadows::PersistedShadow

pub struct PersistedShadow<'a, S: ShadowState + DeserializeOwned, M: Mqtt, D: ShadowDAO<S>> { /* private fields */ }

Implementations

impl<'a, S, M, D> PersistedShadow<'a, S, M, D>where
    S: ShadowState + DeserializeOwned,
    M: Mqtt,
    D: ShadowDAO<S>,

pub fn new(
    initial_state: S,
    mqtt: &'a M,
    dao: D,
    auto_subscribe: bool
) -> Result<Self, Error>

Instantiate a new shadow that will be automatically persisted to NVM based on the passed DAO.

pub fn subscribe(&self) -> Result<(), Error>

Subscribes to all the topics required for keeping a shadow in sync

pub fn unsubscribe(&self) -> Result<(), Error>

Unsubscribes from all the topics required for keeping a shadow in sync

pub fn should_handle_topic(&mut self, topic: &str) -> bool

Helper function to check whether a topic name is relevant for this particular shadow.

pub fn handle_message(
    &mut self,
    topic: &str,
    payload: &[u8]
) -> Result<(&S, Option<S::PatchState>), Error>

Handle incomming publish messages from the cloud on any topics relevant for this particular shadow.

This function needs to be fed all relevant incoming MQTT payloads in order for the shadow manager to work.

pub fn get(&self) -> &S

Get an immutable reference to the internal local state.

pub fn get_shadow(&self) -> Result<(), Error>

Initiate a GetShadow request, updating the local state from the cloud.

pub fn report_shadow(&mut self) -> Result<(), Error>

Initiate an UpdateShadow request, reporting the local state to the cloud.

pub fn update<F: FnOnce(&S, &mut S::PatchState)>(
    &mut self,
    f: F
) -> Result<(), Error>

Update the state of the shadow.

This function will update the desired state of the shadow in the cloud, and depending on whether the state update is rejected or accepted, it will automatically update the local version after response

pub fn delete_shadow(&mut self) -> Result<(), Error>