Struct MemoryBoundedQueue 

pub struct MemoryBoundedQueue<T: Ord> { /* private fields */ }

A priority queue bounded by total bytes (not item count)

Key properties:

• Items are ordered by their Ord implementation (higher priority first)
• push() blocks when adding would exceed capacity
• pull() returns highest priority item, blocks when queue is empty (returns None when closed)
• Provides automatic backpressure for constant memory usage

This matches C++ AGC’s CBoundedPQueue architecture.

Implementations

impl<T: Ord> MemoryBoundedQueue<T>

pub fn new(capacity_bytes: usize) -> Self

Create a new memory-bounded priority queue

Arguments

• capacity_bytes - Maximum total bytes allowed in queue

Example

use ragc_core::MemoryBoundedQueue;
// Note: T must implement Ord for priority ordering
let queue: MemoryBoundedQueue<usize> = MemoryBoundedQueue::new(2 * 1024 * 1024 * 1024); // 2 GB

pub fn push(&self, item: T, size_bytes: usize) -> Result<(), PushError>

Push an item to the queue with its size

BLOCKS if adding this item would exceed capacity. Returns error if queue is closed.

Arguments

• item - The item to push
• size_bytes - Size of the item in bytes

Example

let contig_data = vec![b'A'; 1000];
queue.push(contig_data.clone(), contig_data.len()).unwrap(); // Blocks if queue is full!

pub fn try_push(&self, item: T, size_bytes: usize) -> Result<(), TryPushError>

Try to push without blocking

Returns Err(WouldBlock) if adding would exceed capacity.

pub fn pull(&self) -> Option<T>

Pull highest-priority item from the queue

BLOCKS if queue is empty. Returns None if queue is closed and empty.

Items are returned in priority order (highest priority first).

Example

while let Some(item) = queue.pull() {
    // process highest-priority item
}
// Queue is closed and empty - we're done!

pub fn try_pull(&self) -> Option<T>

Try to pull highest-priority item without blocking

Returns None if queue is empty (even if not closed).

pub fn close(&self)

Close the queue

After closing:

• No more pushes allowed (returns error)
• Pulls will drain remaining items, then return None
• Workers can detect completion via pull() returning None

pub fn is_closed(&self) -> bool

Check if queue is closed

pub fn current_size(&self) -> usize

Get current size in bytes

pub fn len(&self) -> usize

Get current item count

pub fn is_empty(&self) -> bool

Check if queue is empty

pub fn capacity(&self) -> usize

Get capacity in bytes

Trait Implementations

impl<T: Ord> Clone for MemoryBoundedQueue<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.