Struct PathStrategy 

pub struct PathStrategy {
    pub policies: Vec<Arc<dyn PathPolicy>>,
    pub scoring: PathScorer,
}

PathStrategy combines multiple path operations into a single strategy.

Fields

policies: Vec<Arc<dyn PathPolicy>>

The path policies to apply.

scoring: PathScorer

The path ranking functions to apply.

Implementations

impl PathStrategy

pub fn add_policy(&mut self, policy: impl PathPolicy)

Appends a path policy to the list of policies.

pub fn add_scoring(&mut self, scoring: impl PathScoring, impact: f32)

Adds a path scorer with the given impact weight.

Scores from paths are used to select the best path among multiple candidates.

scorer - The path scorer to add. impact - The weight of the scorer in the final score aggregation. e.g. Impact of 0.2 means the scorer can change the final score by up to ±0.2.

Note: The impact weight does not need to sum to 1.0 across all scorers.

pub fn rank_order( &self, this: &PathManagerPath, other: &PathManagerPath, now: SystemTime, ) -> Ordering

Ranks the order of two paths based on preference.

Return

Returns the preference ordering between two paths.

• Ordering::Less if this is preferred over other
• Ordering::Greater if other is preferred over this
• Ordering::Equal if both paths are equally preferred

pub fn rank_inplace(&self, path: &mut [PathManagerPath], now: SystemTime)

Sorts the given paths in place, placing the most preferred paths first.

If no ranking functions are added, the paths are not modified.

pub fn predicate(&self, path: &Path) -> bool

Returns true if the given path is accepted by all policies.

If no policies are added, all paths are accepted.

pub fn filter_inplace<'path: 'iter, 'iter>(&self, paths: &mut Vec<Path>)

Filters the given paths based on all policies, removing paths that are not accepted.

Trait Implementations

impl Default for PathStrategy

fn default() -> PathStrategy

Returns the “default value” for a type.