Skip to main content

PathSet

Struct PathSet 

Source
pub struct PathSet { /* private fields */ }
Expand description

A bounded set of alternative paths for a single destination.

paths[0] is always the primary (best) path. Ranking: lowest hops first, then most-recent timestamp.

Implementations§

Source§

impl PathSet

Source

pub fn from_single(entry: PathEntry, capacity: usize) -> Self

Create a new PathSet containing a single path.

Source

pub fn primary(&self) -> Option<&PathEntry>

Access the primary (best) path, if any.

Source

pub fn primary_mut(&mut self) -> Option<&mut PathEntry>

Mutable access to the primary path.

Source

pub fn is_empty(&self) -> bool

Whether the set contains any paths.

Source

pub fn len(&self) -> usize

Number of stored paths.

Source

pub fn iter(&self) -> impl Iterator<Item = &PathEntry>

Iterator over all paths (primary first).

Source

pub fn upsert(&mut self, entry: PathEntry)

Insert or update a path entry.

  • If a path with the same next_hop already exists, it is replaced in-place.
  • Otherwise the entry is added as an alternative. If at capacity the worst path (highest hops, then oldest) is evicted.

After mutation the vector is re-sorted so paths[0] remains the best.

Source

pub fn failover(&mut self, remove: bool)

Promote the next-best path after the current primary becomes unresponsive.

If remove is true the old primary is discarded; otherwise it is moved to the back of the list (it may recover later).

Source

pub fn cull( &mut self, now: f64, interface_exists: impl Fn(&InterfaceId) -> bool, )

Remove expired or orphaned paths.

interface_exists is a predicate that checks whether an interface is still registered.

Source

pub fn retain(&mut self, predicate: impl Fn(&PathEntry) -> bool)

Filter paths by a predicate, keeping only those that match.

Source

pub fn expire_all(&mut self)

Expire all paths in this set (set timestamp/expires to 0).

Source

pub fn all_random_blobs(&self) -> Vec<[u8; 10]>

Collect all random_blobs across every path in this set.

Source

pub fn find_by_next_hop(&self, next_hop: &[u8; 16]) -> Option<&PathEntry>

Find the path entry that matches a given next_hop, if any.

Trait Implementations§

Source§

impl Clone for PathSet

Source§

fn clone(&self) -> PathSet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PathSet

Source§

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

Formats the value using the given formatter. Read more

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.