Struct matrix_sdk_common::failures_cache::FailuresCache

source ·
pub struct FailuresCache<T: Eq + Hash> { /* private fields */ }
Expand description

A TTL cache where items get inactive instead of discarded.

The items need to be explicitly removed from the cache. This allows us to implement exponential backoff based TTL.

Implementations§

source§

impl<T> FailuresCache<T>
where T: Eq + Hash,

source

pub fn new() -> Self

source

pub fn with_settings(max_delay: Duration, multiplier: u8) -> Self

source

pub fn contains<Q>(&self, key: &Q) -> bool
where T: Borrow<Q>, Q: Hash + Eq + ?Sized,

Is the given key non-expired and part of the cache.

source

pub fn failure_count<Q>(&self, key: &Q) -> Option<u8>
where T: Borrow<Q>, Q: Hash + Eq + ?Sized,

Get the failure count for a given key.

§Returns
  • None if this key is not in the failure cache. (It has never failed, or it has been FailuresCache::remove()d since the last failure.)

  • Some(u8): the number of times it has failed since it was first added to the failure cache. (In other words, one less than the total number of failures.)

source

pub fn insert(&self, item: T)

Add a single item to the cache.

source

pub fn extend(&self, iterator: impl IntoIterator<Item = T>)

Extend the cache with the given iterator of items.

Items that are already part of the cache, whether they are expired or not, will have their TTL extended using an exponential backoff algorithm.

source

pub fn remove<'a, I, Q>(&'a self, iterator: I)
where I: Iterator<Item = &'a Q>, T: Borrow<Q>, Q: Hash + Eq + 'a + ?Sized,

Remove the items contained in the iterator from the cache.

Trait Implementations§

source§

impl<T: Clone + Eq + Hash> Clone for FailuresCache<T>

source§

fn clone(&self) -> FailuresCache<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + Eq + Hash> Debug for FailuresCache<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Eq + Hash> Default for FailuresCache<T>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for FailuresCache<T>

§

impl<T> RefUnwindSafe for FailuresCache<T>

§

impl<T> Send for FailuresCache<T>
where T: Send + Sync,

§

impl<T> Sync for FailuresCache<T>
where T: Send + Sync,

§

impl<T> Unpin for FailuresCache<T>

§

impl<T> UnwindSafe for FailuresCache<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,