Struct UtdHookManager

pub struct UtdHookManager { /* private fields */ }

A manager over an existing UnableToDecryptHook that deduplicates UTDs on similar events, and adds basic consistency checks.

It can also implement a grace period before reporting an event as a UTD, if configured with Self::with_max_delay. Instead of immediately reporting the UTD, the reporting will be delayed by the max delay at most; if the event could eventually get decrypted, it may be reported before the end of that delay.

Implementations

impl UtdHookManager

pub fn new(parent: Arc<dyn UnableToDecryptHook>, client: Client) -> Self

Create a new UtdHookManager for the given hook.

A Client must also be provided; this provides a link to the matrix_sdk_base::StateStore which is used to load and store the persistent data.

pub fn with_max_delay(self, delay: Duration) -> Self

Reports UTDs with the given max delay.

Note: late decryptions are always reported, even if there was a grace period set for the reporting of the UTD.

pub async fn reload_from_store(&mut self) -> Result<(), StoreError>

Load the persistent data for the UTD hook from the store.

If the client previously used a UtdHookManager, and UTDs were encountered, the data on the reported UTDs is loaded from the store. Otherwise, there is no effect.

Trait Implementations

impl Debug for UtdHookManager

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

Formats the value using the given formatter.

impl Drop for UtdHookManager

fn drop(&mut self)

Executes the destructor for this type.