Struct bookkeeping::Book

pub struct Book<T: Metadata> { /* fields omitted */ }

Entry point to the API and retains ownership of accounts, units and moves.

A reference to a book is an argument in any call to create a new account, unit or move. The new entity is both registered in the book and returned in an std::rc::Rc. Since the book retains an Rc of that entity, the returned Rc may be dropped.

Implementations

impl<T: Metadata> Book<T>

pub fn new(meta: T::Book) -> Self

Creates a new book

impl<T: Metadata> Book<T>

pub fn set_metadata(&self, meta: T::Book)

Sets the metadata value on this entity.

pub fn get_metadata(&self) -> Ref<'_, T::Book>

Gets the metadata value on this entity.

Internally, the field that holds metadata is an std::cell::RefCell. Ideally, I would not like to leak this detail through the public API by returning std::cell::Ref here. Yet, I'm not sure what the alternative is. Perhaps returning a clone?

Trait Implementations

impl<T: Metadata> Debug for Book<T>

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

Formats the value using the given formatter.

impl<T: Default + Metadata> Default for Book<T> where
    T::Book: Default, 

pub fn default() -> Book<T>

Returns the "default value" for a type.

impl<T: Metadata> Drop for Book<T>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<T: Metadata> PartialEq<Book<T>> for Book<T>

pub fn eq(&self, other: &Book<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.