Skip to main content

AuxiliaryPacketInfo

Struct AuxiliaryPacketInfo 

Source
pub struct AuxiliaryPacketInfo {
    pub packet_signals: PacketSignals,
    pub num_surbs: usize,
    pub num_evicted_surbs: usize,
    pub min_return_path_hops: Option<u8>,
}
Expand description

Contains some miscellaneous information about a received packet.

Fields§

§packet_signals: PacketSignals

Packet signals that the packet carried.

Zero if no signal flags were specified.

§num_surbs: usize

Number of SURBs that the packet carried.

§num_evicted_surbs: usize

How many SURBs the store lost on arrival: the ones that left it, or never entered it, because the per-pseudonym buffer was already full (SurbInsertOutcome::evicted, a share-less newcomer the store turned away included), plus the ones a newer SURB generation wiped or an older one refused (SurbInsertOutcome::superseded). The batch the packet itself carries is counted in num_surbs, so a refused older-generation batch shows up here as its own size.

This is the only point at which an overflow is visible per packet. The store gives up share-less SURBs first, and refuses a share-less newcomer before it evicts a share-bearing SURB, so what an eviction costs depends on what the buffer holds. A share-less SURB is only a lost return path. A share-bearing one carries a partial SSA share that reaches the reconstructor only when the SURB is used, so evicting it destroys the share. That only happens once the buffer holds nothing but shares, which makes this count an upper bound on the shares lost. The exact figure is SurbInsertOutcome::evicted_shares. It is deliberately not carried here: it is the store’s own business, reported in its eviction summary (the ring_share value of the cache label of hopr_surb_store_evictions_count, and a warning per report interval). The redundancy budget that absorbs those losses is a fixed surplus per polynomial, and emission is windowed, so on deployed dimensions a burst of roughly surplus × SHARE_EMISSION_WINDOW evicted share-bearing SURBs (40 448 at the deployed 79 surplus shares and a window of 512) is enough to put polynomials below their threshold — and a cycle short of recovery is worth nothing at all. See SurbStoreConfig::rb_capacity and hopr_protocol_pix::SHARE_EMISSION_WINDOW.

The Exit’s Session books this count into its SURB flow estimate — an evicted SURB has left the buffer just as a spent one has — so the meaning above must not change: it is the total of SURBs that left or never entered the store, not the number of lost shares. The superseded ones belong in it for the same reason: after the Entry advances the SURB generation, the Exit’s stock is gone, and the keep-alive that reports its level must say so, or the Entry would read the pre-wipe level back and never refill. See counterparty_buffer_capacity in hopr-transport-session.

§min_return_path_hops: Option<u8>

Fewest intermediate hops on the return path of any SURB the packet carried, or None if it carried none.

Read off each SURB’s Proof-of-Relay chain length (hops + 1), the same value the reply ticket is priced by, so it is the SURB creator’s word rather than something this node checked. Some(0) means at least one SURB routes the reply straight back to its creator, with no first relayer to acknowledge it — and that acknowledgement is what a PIX share is decrypted with.

Trait Implementations§

Source§

impl Clone for AuxiliaryPacketInfo

Source§

fn clone(&self) -> AuxiliaryPacketInfo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for AuxiliaryPacketInfo

Source§

impl Debug for AuxiliaryPacketInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AuxiliaryPacketInfo

Source§

fn default() -> AuxiliaryPacketInfo

Returns the “default value” for a type. Read more
Source§

impl Eq for AuxiliaryPacketInfo

Source§

impl PartialEq for AuxiliaryPacketInfo

Source§

fn eq(&self, other: &AuxiliaryPacketInfo) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AuxiliaryPacketInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more