This reference describes unreleased code on main; no release documents it yet.

rlmesh::types::EpisodeState

structPreviewuse rlmesh::types::EpisodeState;[source]

One episode's free state, holding any Send value per key. It lives until the episode ends.

struct EpisodeState

Methods

fn get<T: Any>(&self, key: &str) -> Option<&T>

The value under key, if present and a T.

fn get_mut<T: Any>(&mut self, key: &str) -> Option<&mut T>

The value under key, mutably, if present and a T.

fn insert<T: Any + Send>(
    &mut self,
    key: impl Into<String>,
    value: T,
) -> Option<Box<dyn Any + Send>>

Store value under key; the value it replaced, if any.

fn get_or_insert_with<T: Any + Send>(
    &mut self,
    key: &str,
    f: impl FnOnce() -> T,
) -> Result<&mut T>

The T under key, inserting f() when the key is missing. A key holding another type is the TypeError class naming it.

fn remove(&mut self, key: &str) -> Option<Box<dyn Any + Send>>

Remove the value under key.

fn contains_key(&self, key: &str) -> bool

Whether key holds a value.

fn len(&self) -> usize

How many keys hold a value.

fn is_empty(&self) -> bool

Whether no key holds a value.