pub struct SurbInsertOutcome {
pub retained: usize,
pub evicted: usize,
pub evicted_shares: usize,
pub superseded: usize,
}Expand description
What storing SURBs via SurbStore::insert_surbs did to the ring buffer.
The evicted count exists because an overflow is otherwise entirely silent: the buffer drops a
SURB to make room — a share-less one whenever there is one to drop — and the caller sees only that
the insert “succeeded”. That count is the only local evidence that the sender is producing faster
than this side can hold. It does not say what the overflow cost, though. Under PIX a share reaches
the reconstructor only when its SURB is used, so an evicted share-bearing SURB takes its share
with it permanently, whereas a share-less one is only a lost return path. evicted_shares is the
exact number of shares lost to overflow, which is what tells routine share-less churn from a loss
that matters.
The superseded count is the other way SURBs leave the buffer: not capacity pressure, but a
change of SURB generation. It is kept apart from evicted so that the eviction summary and the
overflow log stay a statement about capacity, while a caller that must know what the store really
holds (the Exit’s flow estimate) can add the two.
Fields§
§retained: usizeNumber of SURBs held for the pseudonym after the insert.
evicted: usizeNumber of SURBs that left, or never entered, the buffer to make room during this insert: share-less ones first, oldest first, and the oldest share-bearing one only once none remain. A share-less SURB turned away because the buffer held nothing but shares counts as well.
Of evicted, how many carried a PIX share: the exact number of shares this
insert lost to overflow, each of them for good. It is zero for as long as the buffer still has
share-less SURBs to give up, and for every refused share-less newcomer.
evicted - evicted_shares is the number of share-less SURBs dropped or refused, which cost a
return path and nothing more.
superseded: usizeNumber of SURBs the generation rule took out of play during this insert, which is not capacity
pressure and so is not part of evicted:
- on a newer generation, everything the buffer held (both tiers), cleared before the batch went in;
- on an older generation, the batch itself, refused as a late or reordered leftover.
The Entry advances the generation when a relayer is judged dead, precisely so that the Exit stops spending the SURBs it holds. Those SURBs are gone from the Exit’s buffer all the same, and the Exit’s flow estimate has to say so.
Trait Implementations§
Source§impl Clone for SurbInsertOutcome
impl Clone for SurbInsertOutcome
Source§fn clone(&self) -> SurbInsertOutcome
fn clone(&self) -> SurbInsertOutcome
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for SurbInsertOutcome
Source§impl Debug for SurbInsertOutcome
impl Debug for SurbInsertOutcome
Source§impl Default for SurbInsertOutcome
impl Default for SurbInsertOutcome
Source§fn default() -> SurbInsertOutcome
fn default() -> SurbInsertOutcome
impl Eq for SurbInsertOutcome
Source§impl PartialEq for SurbInsertOutcome
impl PartialEq for SurbInsertOutcome
impl StructuralPartialEq for SurbInsertOutcome
Auto Trait Implementations§
impl Freeze for SurbInsertOutcome
impl RefUnwindSafe for SurbInsertOutcome
impl Send for SurbInsertOutcome
impl Sync for SurbInsertOutcome
impl Unpin for SurbInsertOutcome
impl UnsafeUnpin for SurbInsertOutcome
impl UnwindSafe for SurbInsertOutcome
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more