Struct persian_rug::Table

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

A holder for Contextual objects.

It is unlikely that you will ever need to instantiate this class, unless for some reason the persian_rug attribute macro which creates Context implementations is not suitable for your use.

A context object will generally have one table per object type, and that table does the work of storing, retrieving and iterating over objects of that type, and the Proxy objects that refer to them.

Implementations

impl<T> Table<T>

pub fn new() -> Self

Create a new table.

Tables are created empty.

pub fn push(&mut self, value: T) -> Proxy<T>

Insert a new item.

The return value is a Proxy that you can store, and later use to retrieve the stored object from the table.

pub fn get(&self, p: &Proxy<T>) -> Option<&T>

Retrieve a previously stored item.

Note that the return value is an Option, because not all Proxy objects of a given type can be necessarily retrieved from a given Table. This is clearly the ideal however, and Context implementations created with the persian_rug attribute macro unwrap this return value, causing a panic on failure.

pub fn get_mut(&mut self, p: &Proxy<T>) -> Option<&mut T>

Retrieve a previously stored item mutably.

Note that the return value is an Option, because not all Proxy objects of a given type can be necessarily retrieved from a given Table. This is clearly the ideal however, and Context implementations created with the persian_rug attribute macro unwrap this return value, causing a panic on failure.

pub fn iter(&self) -> TableIterator<'_, T>

Iterate over shared references to all stored items.

pub fn iter_mut(&mut self) -> TableMutIterator<'_, T>

Iterate over mutable references to all stored items.

pub fn iter_proxies(&self) -> TableProxyIterator<'_, T>

Iterate over proxies for all stored items.

Note that Proxy implements Copy so that although this returns references, you can cheaply convert them to owned values as required with the copied method on Iterator.

Trait Implementations

impl<T: Clone> Clone for Table<T>

fn clone(&self) -> Table<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Table<T>

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

Formats the value using the given formatter.

impl<T> Default for Table<T>

fn default() -> Self

Returns the “default value” for a type.