Struct caminos_lib::routing::RoutingNextCandidates

pub struct RoutingNextCandidates {
    pub candidates: Vec<CandidateEgress>,
    pub idempotent: bool,
}

The candidates as provided by the routing together with related information. This is, the return type of Routing::next.

Fields

candidates: Vec<CandidateEgress>

The vector of candidates.

idempotent: bool

Whether sucessive calls to the routing algorithm will find the exact same set of candidates. If a call returns a RoutingNextCandidates with some value of idempotent then successive calls should also have that same value of idempotent. Returning idempotent to false allows to change the candidates in another call but this field should be kept to false. Setting this flag to true allows the Router to skip calls to the routing algorithm or even to skip some events of the router.

Implementations

impl RoutingNextCandidates

pub fn len(&self) -> usize

Trait Implementations

impl Clone for RoutingNextCandidates

fn clone(&self) -> RoutingNextCandidates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoutingNextCandidates

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

Formats the value using the given formatter.

impl Default for RoutingNextCandidates

fn default() -> RoutingNextCandidates

Returns the “default value” for a type.

impl From<RoutingNextCandidates> for Vec<CandidateEgress>

fn from(candidates: RoutingNextCandidates) -> Self

Converts to this type from the input type.

impl IntoIterator for RoutingNextCandidates

type Item = CandidateEgress

The type of the elements being iterated over.

type IntoIter = <Vec<CandidateEgress> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Self as IntoIterator>::IntoIter

Creates an iterator from a value.