Struct Cache

pub struct Cache<T> { /* private fields */ }

A simple caching struct that can be used to locally maintain a synchronized state with an actor

Implementations

impl<T> Cache<T>

where T: Clone + Send + Sync + 'static,

pub fn has_updates(&self) -> bool

Returns if any new updates are received

pub fn get_newest(&mut self) -> &T

Returns the newest value available, even if the channel is closed Note that when the cache is initialized with a default value, this might return the default while the actor has a different value

pub fn get_current(&self) -> &T

Returns the current value held by the cache, without synchronizing with the actor

pub async fn recv_newest(&mut self) -> Result<&T, CacheRecvNewestError>

Receive the newest updated value broadcasted by the actor, discarding any older messages. The first time it will return its current value immediately After that, it might wait indefinitely for a new update Note that when the cache is initialized with a default value, this might return the default while the actor has a different value

pub async fn recv(&mut self) -> Result<&T, CacheRecvError>

Receive the last updated value broadcasted by the actor (FIFO). The first time it will return its current value immediately After that, it might wait indefinitely for a new update Note that when the cache is initialized with a default value, this might return the default while the actor has a different value

pub fn try_recv_newest(&mut self) -> Result<Option<&T>, CacheRecvNewestError>

Try to receive the newest updated value broadcasted by the actor, discarding any older messages. The first time it will return its initialized value, even if no updates are present. After that, lacking updates will return None. Note that when the cache is initialized with a default value, this might return None while the actor has a value

pub fn try_recv(&mut self) -> Result<Option<&T>, CacheRecvError>

Try to receive the last updated value broadcasted by the actor once (FIFO). The first time it will return its initialized value, even if no updates are present. After that, lacking updates will return None. Note that when the cache is initialized with a default value, this might return None while the actor has a value

pub fn spawn_throttle<C, F>(&self, client: C, call: fn(&C, F), freq: Frequency)

where C: Send + Sync + 'static, T: Throttled<F>, F: Clone + Send + Sync + 'static,

Spawns a throttle that fires given a specificed Frequency, given any broadcasted updates by the actor. Does not first update the cache to the newest value, since then the user of the cache might miss the update

Trait Implementations

impl<T> Clone for Cache<T>

where T: Clone + Send + Sync + 'static,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Cache<T>

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

Formats the value using the given formatter.