Struct LCMCache 

pub struct LCMCache { /* private fields */ }

A simple passthrough cache that preferentially returns cached LCM data for a room, dynamically generating LCM data as-needed from a user-provided closure and caching it before returning it.

Implementations

impl LCMCache

pub fn new() -> Self

Initializes a new, empty LCM cache.

pub fn get_cached_lcm(&self, room_name: &RoomName) -> Option<&LocalCostMatrix>

Returns the cached LCM, if it exists.

Returns None if the LCM isn’t cached.

pub fn is_lcm_cached(&self, room_name: &RoomName) -> bool

Returns whether an LCM is cached for a particular room.

pub fn get_lcm( &mut self, room_name: &RoomName, generator_fn: impl FnOnce(&RoomName) -> LocalCostMatrix, ) -> &LocalCostMatrix

Returns the room LCM, generating and caching it if it’s not already cached.

pub fn update_cached_lcm(&mut self, room_name: RoomName, lcm: LocalCostMatrix)

Updates the LCM cache for a specific room.

This allows for pre-loading the cache with any existing room LCM data you might already have available.

pub fn remove_cached_lcm(&mut self, room_name: &RoomName)

Removes the LCM cached for a specific room.

Trait Implementations

impl Clone for LCMCache

fn clone(&self) -> LCMCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LCMCache

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

Formats the value using the given formatter.

impl Default for LCMCache

fn default() -> Self

Returns the “default value” for a type.