Struct stepflow_base::ObjectStore

pub struct ObjectStore<T, TID> where
    TID: Eq + Hash,  { /* fields omitted */ }

A store for objects that are weak referenced by an ID and optional name.

There are two different ways to insert an object.

• Use insert_new which takes a closure that receives the ID for the new object
• Get an ID with reserve_id and then register the object with that ID

To add objects with an associated name, use the corresponding insert_new_named and register_named instead.

Examples

// create an ObjectStore with a test object
let mut store = ObjectStore::new();
let object_id = store.insert_new_named("test object", |id| Ok(Object { id })).unwrap();

// get the object either by ID or name
let object = store.get(&object_id).unwrap();
let object = store.get_by_name("test object").unwrap();

Implementations

impl<'s, T, TID> ObjectStore<T, TID> where
    T: ObjectStoreContent + ObjectStoreContent<IdType = TID>,
    TID: Eq + Hash + Clone, 

pub fn new() -> Self

Create a new ObjectStore

pub fn with_capacity(capacity: usize) -> Self

Create a new ObjectStore with initial capacity

pub fn reserve_id(&mut self) -> TID

Reserve an ID in the ObjectStore. Generally followed with a call to register using the ID.

pub fn register(&mut self, object: T) -> Result<TID, IdError<TID>>

Registers an object into the ObjectStore

pub fn register_named<STR>(
    &mut self,
    name: STR,
    object: T
) -> Result<TID, IdError<TID>> where
    STR: Into<Cow<'static, str>>, 

Registers a named object into the ObjectStore

pub fn insert_new<CB>(&mut self, cb: CB) -> Result<TID, IdError<TID>> where
    CB: FnOnce(TID) -> Result<T, IdError<TID>>, 

Reserves an ID and registers the object in a single call. The object created must use the ID given to the closure.

pub fn insert_new_named<CB, STR>(
    &mut self,
    name: STR,
    cb: CB
) -> Result<TID, IdError<TID>> where
    CB: FnOnce(TID) -> Result<T, IdError<TID>>,
    STR: Into<Cow<'static, str>>, 

Reserves an ID and registers the named object in a single call. The object created must use the ID given to the closure.

pub fn id_from_name(&self, name: &str) -> Option<&TID>

Get the Object ID from the name

pub fn name_from_id(&self, id: &TID) -> Option<&str>

Get the name from the Object ID

pub fn get_by_name(&self, name: &str) -> Option<&T>

Get an object by its name

pub fn get(&self, id: &TID) -> Option<&T>

Get an object by its ID

pub fn get_mut(&mut self, id: &TID) -> Option<&mut T>

Get a mutable reference to the object

pub fn iter_names(&self) -> impl Iterator<Item = (&Cow<'static, str>, &TID)>

Trait Implementations

impl<T: Debug, TID: Debug> Debug for ObjectStore<T, TID> where
    TID: Eq + Hash, 

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

Formats the value using the given formatter.