Struct SurbRingBuffer 

pub struct SurbRingBuffer<S> {
    surbs: Arc<Mutex<VecDeque<(HoprSurbId, S)>>>,
    capacity: usize,
    pop_order: SurbPopOrder,
}

Ring buffer of SURBs and their IDs, all normally belonging to one pseudonym and therefore identified only by [HoprSurbId].

Backed by a VecDeque pre-allocated to capacity and never allowed to exceed it, so it never reallocates: a push into a full buffer evicts the oldest element first. SurbPopOrder picks which end a pop consumes from; overflow always evicts the oldest, in either order.

Fields

surbs: Arc<Mutex<VecDeque<(HoprSurbId, S)>>>

capacity: usize

pop_order: SurbPopOrder

Implementations

impl<S> SurbRingBuffer<S>

pub fn new(capacity: usize, pop_order: SurbPopOrder) -> Self

Creates a buffer holding at most capacity (min 1, so a push is never a no-op) SURBs, popped in the given order.

pub fn push<I: IntoIterator<Item = (HoprSurbId, S)>>( &self, surbs: I, ) -> SurbInsertOutcome

Pushes all SURBs with their IDs, evicting the oldest ones past capacity.

Returns what the push did; the eviction count is what lets a caller notice the overflow at all, since dropping the oldest entry is otherwise indistinguishable from a clean insert.

pub fn pop_next_valid<F>(&self, is_valid: F) -> Option<PoppedSurb<S>>

where F: Fn(&HoprSurbId, &S) -> bool,

Pops the next SURB that is_valid accepts, in the buffer’s SurbPopOrder.

Destructive: rejected entries are discarded, not skipped, so an unusable SURB neither is handed out nor blocks those behind it. Pass only a validity test — a selective predicate (say, a routing preference) would drain the buffer. None once it is exhausted without a match.

is_valid runs outside the lock: it is caller-supplied and may take locks of its own, so calling it inside the critical section would invite lock-order inversion.

pub fn pop_one_if_has_id(&self, id: &HoprSurbId) -> Option<PoppedSurb<S>>

Pops the next SURB (in the buffer’s SurbPopOrder) only if it has the given ID.

Trait Implementations

impl<S: Clone> Clone for SurbRingBuffer<S>

fn clone(&self) -> SurbRingBuffer<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for SurbRingBuffer<S>

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

Formats the value using the given formatter.