Struct ValueCachedQueue 

pub struct ValueCachedQueue<Q> {
    queue: Q,
    value_cache: HashMap<u32, HoprBalance>,
}

Adapter for TicketQueue that caches the total ticket value per channel epoch.

The cache value is updated with each push and pop operation. The total_value method returns the cached value if available, otherwise it delegates to the underlying queue. If min_index is provided, the cache is bypassed and the underlying queue is queried directly.

All other calls are simply delegated to the underlying queue.

The implementation uses hashbrown::HashMap for efficient key-value storage.

Fields

queue: Q

value_cache: HashMap<u32, HoprBalance>

Implementations

impl<Q: TicketQueue> ValueCachedQueue<Q>

pub fn new(queue: Q) -> Result<Self, Q::Error>

Trait Implementations

impl<Q: Clone> Clone for ValueCachedQueue<Q>

fn clone(&self) -> ValueCachedQueue<Q>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q: Debug> Debug for ValueCachedQueue<Q>

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

Formats the value using the given formatter.

impl<Q: TicketQueue> TicketQueue for ValueCachedQueue<Q>

type Error = <Q as TicketQueue>::Error

fn len(&self) -> Result<usize, Self::Error>

Number of tickets in the queue.

fn is_empty(&self) -> Result<bool, Self::Error>

Indicates whether the queue is empty.

fn push(&mut self, ticket: RedeemableTicket) -> Result<(), Self::Error>

Add a ticket to the queue.

fn pop(&mut self) -> Result<Option<RedeemableTicket>, Self::Error>

Remove and return the next ticket in-order from the queue.

fn peek(&self) -> Result<Option<RedeemableTicket>, Self::Error>

Return the next ticket in-order from the queue without removing it.

fn iter_unordered( &self, ) -> Result<impl Iterator<Item = Result<RedeemableTicket, Self::Error>>, Self::Error>

Iterate over all tickets in the queue in arbitrary order.

fn total_value( &self, epoch: u32, min_index: Option<u64>, ) -> Result<HoprBalance, Self::Error>

Computes the total value of tickets of the given epoch (and optionally minimum given index) in this queue.

fn drain(&mut self) -> Result<Vec<VerifiedTicket>, Self::Error>

Drains all the remaining tickets from the queue, rendering them no longer redeemable.