Struct all_is_cubes::behavior::BehaviorSetTransaction

pub struct BehaviorSetTransaction<H: BehaviorHost> { /* private fields */ }

A Transaction that adds or modifies Behaviors in a BehaviorSet.

Implementations

impl<H: BehaviorHost> BehaviorSetTransaction<H>

pub fn insert(attachment: H::Attachment, behavior: Arc<dyn Behavior<H>>) -> Self

Constructs a transaction that adds a behavior to the behavior set.

Trait Implementations

impl<H: BehaviorHost> Clone for BehaviorSetTransaction<H>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + BehaviorHost> Debug for BehaviorSetTransaction<H>

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

Formats the value using the given formatter.

impl<H: BehaviorHost> Default for BehaviorSetTransaction<H>

fn default() -> Self

Returns the “default value” for a type.

impl<H: BehaviorHost> Merge for BehaviorSetTransaction<H>

type MergeCheck = MergeCheck

Type of a value passed from Merge::check_merge to Merge::commit_merge. This may be used to pass precalculated values to speed up the merge phase, but also makes it difficult to accidentally merge without checking.

type Conflict = BehaviorTransactionConflict

Error type giving the reason why a merge was not possible.

fn check_merge(&self, other: &Self) -> Result<Self::MergeCheck, Self::Conflict>

Checks whether two transactions can be merged into a single transaction. If so, returns Ok containing data which may be passed to Self::commit_merge().

fn commit_merge(&mut self, other: Self, _: Self::MergeCheck)

Combines other into self so that it has both effects simultaneously. This operation must be commutative and have Default::default() as the identity.

fn merge(self, other: Self) -> Result<Self, Self::Conflict>

Combines two transactions into one which has both effects simultaneously, if possible.

fn merge_from(&mut self, other: Self) -> Result<(), Self::Conflict>

Combines two transactions into one which has both effects simultaneously, if possible.

impl<H: BehaviorHost> PartialEq for BehaviorSetTransaction<H>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H: BehaviorHost> Transaction for BehaviorSetTransaction<H>

type Target = BehaviorSet<H>

Type of the transaction’s target (what it can be used to mutate).

type CommitCheck = CommitCheck

Type of a value passed from Transaction::check to Transaction::commit. This may be used to pass precalculated values to speed up the commit phase, or even lock guards or similar, but also makes it slightly harder to accidentally call commit without check.

type Output = Infallible

The results of a Transaction::commit() or Transaction::execute(). Each commit may produce any number of these messages.

type Mismatch = BehaviorTransactionMismatch

Error type describing a precondition not met, returned by Self::check().

fn check( &self, target: &BehaviorSet<H>, ) -> Result<Self::CommitCheck, Self::Mismatch>

Checks whether the target’s current state meets the preconditions and returns Err if it does not.

fn commit( &self, target: &mut BehaviorSet<H>, _: Self::CommitCheck, _outputs: &mut dyn FnMut(Self::Output), ) -> Result<(), CommitError>

Perform the mutations specified by this transaction. The check value should have been created by a prior call to Transaction::check().

fn execute( &self, target: &mut Self::Target, outputs: &mut dyn FnMut(Self::Output), ) -> Result<(), ExecuteError<Self>>

Convenience method to execute a transaction in one step. Implementations should not need to override this. Equivalent to:

impl<H: BehaviorHost> Eq for BehaviorSetTransaction<H>