Struct stepflow_base::ObjectStore[][src]

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


// create an ObjectStore with a test object
let mut store = ObjectStore::new();
let object_id = store.insert_new(Some("test object".to_owned()), |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();


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

pub fn new() -> Self[src]

Create a new ObjectStore

pub fn with_capacity(capacity: usize) -> Self[src]

Create a new ObjectStore with initial capacity

pub fn reserve_id(&mut self) -> TID[src]

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

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

Registers an object into the ObjectStore

pub fn insert_new<CB>(
    &mut self,
    name: Option<String>,
    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 id_from_name(&self, name: &str) -> Option<&TID>[src]

Get the Object ID from the name

pub fn name_from_id(&self, id: &TID) -> Option<&String>[src]

Get the name from the Object ID

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

Get an object by its name

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

Get an object by its ID

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

Get a mutable reference to the object

pub fn iter_names(&self) -> impl Iterator<Item = (&String, &TID)>[src]

Trait Implementations

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

Auto Trait Implementations

impl<T, TID> RefUnwindSafe for ObjectStore<T, TID> where
    T: RefUnwindSafe,
    TID: RefUnwindSafe

impl<T, TID> Send for ObjectStore<T, TID> where
    T: Send,
    TID: Send

impl<T, TID> Sync for ObjectStore<T, TID> where
    T: Sync,
    TID: Sync

impl<T, TID> Unpin for ObjectStore<T, TID> where
    T: Unpin,
    TID: Unpin

impl<T, TID> UnwindSafe for ObjectStore<T, TID> where
    T: UnwindSafe,
    TID: UnwindSafe

Blanket Implementations

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

impl<T> AsAny for T where
    T: Any

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

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

impl<T> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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.