Struct all_is_cubes::block::BlockDef

pub struct BlockDef { /* private fields */ }

Contains a Block and can be stored in a Universe. Together with Primitive::Indirect, this allows mutation of a block definition such that all its existing usages follow.

To perform such a mutation, use BlockDefTransaction.

Additionally, it caches the results of block evaluation to improve performance. Note that this cache only updates when the owning Universe is being stepped, or when a direct mutation to this BlockDef is performed, not when the contained Block sends a change notification.

Implementations

impl BlockDef

pub fn new(block: Block) -> Self

Constructs a new BlockDef that stores the given block (which may be replaced in the future).

pub fn block(&self) -> &Block

Returns the current block value.

Note that if you wish to get the EvaluatedBlock result, you should obtain the cached value by calling BlockDef.evaluate(), or by using a Primitive::Indirect, not by calling .block().evaluate(), which is not cached.

pub fn evaluate(&self) -> Result<EvaluatedBlock, EvalBlockError>

Returns the current cached evaluation of the current block value.

This returns the same success or error as Block::from(handle_to_self).evaluate() would, not the same as .block().evaluate() would.

Trait Implementations

impl<'a> Arbitrary<'a> for BlockDef

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl AsRef<Block> for BlockDef

fn as_ref(&self) -> &Block

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for BlockDef

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

Formats the value using the given formatter.

impl Listen for BlockDef

fn listen<L: Listener<BlockChange> + 'static>(&self, listener: L)

Registers a listener for whenever the result of evaluation of this block definition changes. Note that this only occurs when the owning Universe is being stepped.

type Msg = BlockChange

The type of message which may be obtained from this source.

impl Transactional for BlockDef

type Transaction = BlockDefTransaction

The type of transaction which should be used with Self.

fn transact<F, O>(&mut self, f: F) -> Result<O, ExecuteError<Self::Transaction>>

where F: FnOnce(&mut Self::Transaction, &Self) -> Result<O, <Self::Transaction as Merge>::Conflict>, Self::Transaction: Transaction<Target = Self, Output = NoOutput> + Default,

Convenience method for building and then applying a transaction to self, equivalent to the following steps:

impl UTransactional for BlockDef

fn bind( target: Handle<Self>, transaction: Self::Transaction, ) -> UniverseTransaction

Specify the target of the transaction as a Handle, and erase its type, so that it can be combined with other transactions in the same universe.

impl VisitHandles for BlockDef

fn visit_handles(&self, visitor: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.