Struct AlgorithmRegistry 

pub struct AlgorithmRegistry { /* private fields */ }

Algorithms a caller brought, keyed by the name a pool configuration uses to ask for one.

Empty by default, which is every deployment running only the built-ins.

Implementations

impl AlgorithmRegistry

pub fn new() -> Self

A registry holding nothing.

pub fn with_algorithm<A, F>( self, name: impl Into<String>, factory: F, ) -> Result<Self, RegisterAlgorithmError>

where A: Algorithm + 'static, A::GraphManager: MarketEventHandler + EdgeWeightUpdaterWithDerived + 'static, F: Fn(AlgorithmConfig) -> A + Clone + Send + Sync + 'static,

Registers factory under name, so a pool asking for that algorithm is served by it.

The factory is called once per worker thread.

Errors

RegisterAlgorithmError::ShadowsBuiltIn when name is one this crate ships, and RegisterAlgorithmError::AlreadyRegistered when an earlier call took it. Both are refused rather than resolved silently: which algorithm a pool runs is not something to decide by registration order.

pub fn names(&self) -> impl Iterator<Item = &str>

The names this registry can serve, for an error that has to say what was available.

Trait Implementations

impl Clone for AlgorithmRegistry

fn clone(&self) -> AlgorithmRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlgorithmRegistry

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

Names only: the factories behind them cannot be printed.

impl Default for AlgorithmRegistry

fn default() -> AlgorithmRegistry

Returns the “default value” for a type.