Struct KeyObservation

pub struct KeyObservation {
    pub key: Vec<u8>,
    /* private fields */
}

A struct to manage receiving notifications for a key

Fields

key: Vec<u8>

The name of the key (for convenience)

Implementations

impl KeyObservation

pub async fn recv_notification( &mut self, ) -> Option<(KeyNotification, Option<AckToken>)>

Receives a state_store::KeyNotification or None if there will be no more notifications.

If there are notifications:

• Returns Some(state_store::KeyNotification, Option<AckToken>) on success
  • If auto ack is disabled, the AckToken should be used or dropped when you want the ack to occur. If auto ack is enabled, you may use (state_store::KeyNotification, _) to ignore the AckToken.

A received notification can be acknowledged via the AckToken by calling AckToken::ack or dropping the AckToken.

Trait Implementations

impl Debug for KeyObservation

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

Formats the value using the given formatter.