Struct UtxoOverlay 

pub struct UtxoOverlay<'a> { /* private fields */ }

Zero-copy overlay for UTXO set modifications during block validation.

Provides a view over the base UTXO set that captures additions and deletions without copying the underlying data.

Implementations

impl<'a> UtxoOverlay<'a>

pub fn new( base: &'a HashMap<OutPoint, Arc<UTXO>, FxBuildHasher>, ) -> UtxoOverlay<'a>

Create a new overlay over the given UTXO set.

This is O(1) - no copying of the base set.

pub fn with_capacity( base: &'a HashMap<OutPoint, Arc<UTXO>, FxBuildHasher>, additions_cap: usize, deletions_cap: usize, ) -> UtxoOverlay<'a>

Create a new overlay with custom capacity hints.

pub fn get(&self, outpoint: &OutPoint) -> Option<&UTXO>

Look up a UTXO by outpoint.

First checks deletions, then additions, then base set.

pub fn contains_key(&self, outpoint: &OutPoint) -> bool

Check if a UTXO exists.

pub fn insert(&mut self, outpoint: OutPoint, utxo: UTXO)

Add a new UTXO (created by a transaction in this block).

pub fn insert_arc(&mut self, outpoint: OutPoint, utxo: Arc<UTXO>)

Add a new UTXO from Arc. Use when sharing with undo log.

pub fn mark_spent(&mut self, outpoint: &OutPoint)

Mark a UTXO as spent without returning it. Use when the return value is discarded (e.g. IBD path). Avoids cloning the UTXO (~50 bytes per input).

pub fn remove(&mut self, outpoint: &OutPoint) -> Option<Arc<UTXO>>

Mark a UTXO as spent (consumed by a transaction in this block). Returns the UTXO for undo-log path. Use mark_spent when return value is discarded.

pub fn additions_len(&self) -> usize

Get the number of additions in this overlay.

pub fn deletions_len(&self) -> usize

Get the number of deletions in this overlay.

pub fn base_len(&self) -> usize

Get the size of the base UTXO set.

pub fn apply_to_base(self) -> HashMap<OutPoint, Arc<UTXO>, FxBuildHasher>

Apply the overlay changes to produce a new UTXO set.

This is called at the end of successful block validation. Base clone is cheap (Arc refcount only); additions wrapped in Arc.

pub fn additions(&self) -> &HashMap<OutPoint, Arc<UTXO>, FxBuildHasher>

Get immutable access to additions (for undo log generation).

pub fn deletions(&self) -> &HashSet<[u8; 36], FxBuildHasher>

Get immutable access to deletion keys (for undo log generation).

pub fn into_changes( self, ) -> (HashMap<OutPoint, Arc<UTXO>, FxBuildHasher>, HashSet<[u8; 36], FxBuildHasher>)

Consume the overlay and return its changes as owned data.

This releases the borrow on the base UTXO set, allowing the caller to apply the changes directly to the mutable utxo_set without re-iterating all transactions.

Returns (additions, deletions) — the net UTXO changes from this block.

Trait Implementations

impl<'a> Debug for UtxoOverlay<'a>

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

Formats the value using the given formatter.

impl<'a> UtxoLookup for UtxoOverlay<'a>

Implementation of UtxoLookup for UtxoOverlay.

fn get(&self, outpoint: &OutPoint) -> Option<&UTXO>

Look up a UTXO by outpoint.

fn contains_key(&self, outpoint: &OutPoint) -> bool

Check if a UTXO exists.

fn len(&self) -> usize

Get the number of UTXOs (approximate for overlays).

fn is_empty(&self) -> bool

Check if empty.