Struct Heap 

pub struct Heap<H: Hasher = DefaultContentHasher> { /* private fields */ }

Deterministic heap for protocol resources.

Uses BTreeMap for O(log n) operations with deterministic iteration order. The nullifiers set tracks consumed resources to prevent double-spending.

Implementations

impl<H: Hasher> Heap<H>

pub fn new() -> Self

Create an empty heap.

pub fn size(&self) -> usize

Get the number of retained resource entries.

Consumed resources are still retained until removed explicitly.

pub fn nullified_count(&self) -> usize

Get the number of nullified resources.

pub fn contains(&self, rid: &ResourceId<H>) -> bool

Check if a resource exists in the heap (not necessarily active).

pub fn is_consumed(&self, rid: &ResourceId<H>) -> bool

Check if a resource has been consumed (nullified).

pub fn is_active(&self, rid: &ResourceId<H>) -> bool

Check if a resource is active (exists and not consumed).

pub fn alloc_counter(&self) -> u64

Get the current allocation counter.

pub fn alloc(&self, resource: Resource) -> (ResourceId<H>, Heap<H>)

Allocate a new resource on the heap.

Returns the new ResourceId and updated heap. The ResourceId is derived from the resource content and allocation counter.

pub fn alloc_mut(&mut self, resource: Resource) -> ResourceId<H>

Allocate a resource mutably (for efficiency when building heaps).

pub fn read(&self, rid: &ResourceId<H>) -> Result<&Resource, HeapError<H>>

Read a resource from the heap.

Returns an error if the resource doesn’t exist or has been consumed.

pub fn consume(&self, rid: &ResourceId<H>) -> Result<Heap<H>, HeapError<H>>

Consume a resource, adding it to the nullifier set.

Returns an error if the resource doesn’t exist or has already been consumed. The resource remains in the heap but is marked as consumed.

pub fn consume_mut(&mut self, rid: &ResourceId<H>) -> Result<(), HeapError<H>>

Consume a resource mutably.

pub fn remove(&self, rid: &ResourceId<H>) -> Result<Heap<H>, HeapError<H>>

Remove a resource from the heap entirely (for cleanup).

Unlike consume, this removes the resource from both maps. Returns an error if the resource doesn’t exist.

pub fn active_resources( &self, ) -> impl Iterator<Item = (&ResourceId<H>, &Resource)>

Get all active (non-consumed) resources.

pub fn consumed_ids(&self) -> impl Iterator<Item = &ResourceId<H>>

Get all consumed resource IDs.

pub fn alloc_many( &self, resources: impl IntoIterator<Item = Resource>, ) -> (Vec<ResourceId<H>>, Heap<H>)

Allocate multiple resources at once.

pub fn consume_many( &self, rids: &[ResourceId<H>], ) -> Result<Heap<H>, HeapError<H>>

Try to consume multiple resources atomically.

If any consumption fails, returns the error without modifying the heap.

pub fn alloc_channel( &self, sender: &str, receiver: &str, ) -> (ResourceId<H>, Heap<H>)

Create a channel resource and allocate it.

pub fn alloc_message( &self, source: &str, dest: &str, label: &str, payload: Vec<u8>, seq_no: u64, ) -> (ResourceId<H>, Heap<H>)

Create a message resource and allocate it.

pub fn alloc_session( &self, role: &str, type_hash: u64, ) -> (ResourceId<H>, Heap<H>)

Create a session state resource and allocate it.

Trait Implementations

impl<H: Clone + Hasher> Clone for Heap<H>

fn clone(&self) -> Heap<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Debug + Hasher> Debug for Heap<H>

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

Formats the value using the given formatter.

impl<H: Default + Hasher> Default for Heap<H>

fn default() -> Heap<H>

Returns the “default value” for a type.