Skip to main content

HoprGraphPathSelector

Struct HoprGraphPathSelector 

Source
pub struct HoprGraphPathSelector<G> {
    me: OffchainPublicKey,
    graph: G,
    max_paths: usize,
}
Expand description

A lightweight graph-backed path selector.

Returns all candidate paths for a (src, dest, hops) query directly from the network graph — no caching is performed here. The caller (typically crate::planner::PathPlanner) is responsible for caching, TTL management, background refresh, and final path selection.

Stores the planner’s own identity (me) so that it can choose the appropriate cost function:

  • forward path (src == me): [EdgeCostFn::forward]
  • return path (dest == me): [EdgeCostFn::returning]

Fields§

§me: OffchainPublicKey§graph: G§max_paths: usize

Implementations§

Source§

impl<G> HoprGraphPathSelector<G>
where G: NetworkGraphTraverse<NodeId = OffchainPublicKey> + NetworkGraphView<NodeId = OffchainPublicKey> + Clone + Send + Sync + 'static, <G as NetworkGraphTraverse>::Observed: EdgeObservableRead + Send + 'static,

Source

pub fn new(me: OffchainPublicKey, graph: G, max_paths: usize) -> Self

Create a new selector.

  • me – the planner’s own offchain public key, used to determine path direction.
  • graph – the network graph to query.
  • max_paths – maximum number of candidate paths to return per query.

Trait Implementations§

Source§

impl<G: Clone> Clone for HoprGraphPathSelector<G>

Source§

fn clone(&self) -> HoprGraphPathSelector<G>

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<G> PathSelector for HoprGraphPathSelector<G>
where G: NetworkGraphTraverse<NodeId = OffchainPublicKey> + NetworkGraphView<NodeId = OffchainPublicKey> + Clone + Send + Sync + 'static, <G as NetworkGraphTraverse>::Observed: EdgeObservableRead + Send + 'static,

Source§

fn select_path( &self, src: OffchainPublicKey, dest: OffchainPublicKey, hops: usize, ) -> Result<Vec<PathWithCost>>

Return all candidate paths from src to dest via hops relays.

Each returned tuple contains a path Vec<OffchainPublicKey> of length hops + 1 ([intermediates..., dest]; src excluded) paired with its accumulated traversal cost.

Returns Err(PathNotFound) when the graph yields no positive-cost paths.

The function has a potential to run expensive operations, it should be benchmarked in a production environment and possibly guarded (e.g. by offloading the long execution in an async executor to avoid blocking the caller).

Auto Trait Implementations§

§

impl<G> Freeze for HoprGraphPathSelector<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for HoprGraphPathSelector<G>
where G: RefUnwindSafe,

§

impl<G> Send for HoprGraphPathSelector<G>
where G: Send,

§

impl<G> Sync for HoprGraphPathSelector<G>
where G: Sync,

§

impl<G> Unpin for HoprGraphPathSelector<G>
where G: Unpin,

§

impl<G> UnwindSafe for HoprGraphPathSelector<G>
where G: UnwindSafe,

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> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more