Enum SurbPopOrder 

pub enum SurbPopOrder {
    Fifo,
}

Which end of the per-pseudonym buffer a pop consumes from. Replying side only.

FIFO, oldest first, is the only order. SURBs that carry a PIX share are always consumed before share-less ones (see “Share-bearing SURBs first” on the internal SurbRingBuffer), and within each of those two tiers the oldest goes first, whether it is popped or evicted on overflow. The order is independent of the per-SURB generation tag (SurbReceiverInfo::generation), which handles an explicit return-path re-plan by clearing superseded SURBs wholesale on the next push.

There used to be a Lifo variant (hoprnet#8328), consuming newest first so that a return-path change would apply before the buffered SURBs drained. It was removed because PIX cannot work with it: a share reaches the reconstructor only when its SURB is used, so a LIFO store buries the oldest shares of the current cycle, and an overflow then evicts exactly those, which loses them for good. Every node may act as a PIX Exit and nothing in the configuration turns that off (enforce_pix only makes it mandatory), so the option had no safe use — and what it was for is what the generation tag does.

This enum, and the SurbStoreConfig::pop_order field carrying it, remain only so that existing configurations (pop_order: fifo) and code naming SurbPopOrder::Fifo keep working; they are candidates for removal in a later major version. pop_order: lifo is rejected as an unknown variant.

Variants

Fifo

Oldest first. The only order, and the default.

Trait Implementations

impl Clone for SurbPopOrder

fn clone(&self) -> SurbPopOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SurbPopOrder

impl Debug for SurbPopOrder

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

Formats the value using the given formatter.

impl Default for SurbPopOrder

fn default() -> SurbPopOrder

Returns the “default value” for a type.

impl Display for SurbPopOrder

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

Formats the value using the given formatter.

impl Eq for SurbPopOrder

impl FromStr for SurbPopOrder

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SurbPopOrder, <SurbPopOrder as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SurbPopOrder

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SurbPopOrder

fn cmp(&self, other: &SurbPopOrder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SurbPopOrder

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SurbPopOrder

fn partial_cmp(&self, other: &SurbPopOrder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SurbPopOrder

impl TryFrom<&str> for SurbPopOrder

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<SurbPopOrder, <SurbPopOrder as TryFrom<&str>>::Error>

Performs the conversion.