Struct SceneTransactionRecord 

#[non_exhaustive]
pub struct SceneTransactionRecord {
    pub txn: TxnId,
    pub source: ChangeSource,
    pub history: HistoryMode,
    pub outcome: TxnOutcome,
    pub ephemeral: bool,
    pub edits: Vec<SceneEdit>,
}

One committed transaction, delivered to the edit sink with the scene unborrowed.

Owning — it carries the boxes a removal would otherwise drop — and therefore cannot travel through a Signal. That is the whole reason the seam has two channels; see the module docs.

#[non_exhaustive]: this crate has out-of-tree consumers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

txn: TxnId

Matches the txn on every SceneChange this transaction emitted.

source: ChangeSource

Whose change it was.

history: HistoryMode

What a history above the scene should do with it.

outcome: TxnOutcome

How it finished.

ephemeral: bool

true iff every edit in it was emitted while SceneTransaction::ephemeral (or the scene’s own dynamic-bounds refresh) was in effect. Never true for an empty record.

edits: Vec<SceneEdit>

The edits, in application order.

Implementations

impl SceneTransactionRecord

pub fn is_empty(&self) -> bool

Whether this transaction changed nothing. An empty record is never delivered to the sink — a mutator that early-returned on an unchanged value has nothing to reverse.

Trait Implementations

impl Debug for SceneTransactionRecord

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

Formats the value using the given formatter.