Skip to main content

SearchOutcome

Enum SearchOutcome 

Source
#[non_exhaustive]
pub enum SearchOutcome<P, S> { Found { path: P, stats: S, }, NoPath { stats: S, }, }
Expand description

Successful search computation, separate from request validation failures.

Found and NoPath both carry stats so callers can compare effort even when no route exists. Domain-specific input validation remains an outer Err in each owner crate.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Found

A route was found together with algorithm-defined work statistics.

Fields

§path: P

Domain path value (grid path, free-space polyline, corridor path, …).

§stats: S

Algorithm-defined work counters for this successful search.

§

NoPath

Exhaustive search found no route, but still produced work statistics.

Fields

§stats: S

Algorithm-defined work counters for the exhaustive no-path search.

Implementations§

Source§

impl<P, S> SearchOutcome<P, S>

Source

pub const fn found(path: P, stats: S) -> SearchOutcome<P, S>

Successful route with work stats (not a validation error).

Source

pub const fn no_path(stats: S) -> SearchOutcome<P, S>

Exhaustive search found no route; still carries work stats for comparison.

Source

pub const fn is_found(&self) -> bool

Whether this outcome is Self::Found (validation failures are outer Err).

Source

pub const fn path(&self) -> Option<&P>

Path when found; None for Self::NoPath.

Source

pub const fn stats(&self) -> &S

Work stats from either branch (Found and NoPath both always carry stats).

Source§

impl<P, S> SearchOutcome<P, S>
where P: SearchPathCost,

Source

pub fn cost(&self) -> Option<<P as SearchPathCost>::Cost>

Path cost when found; None for no-path outcomes.

Source§

impl<P, S> SearchOutcome<P, S>

Source

pub fn visited_nodes(&self) -> usize

Algorithm-defined visit count from either found or no-path stats.

Trait Implementations§

Source§

impl<P, S> Clone for SearchOutcome<P, S>
where P: Clone, S: Clone,

Source§

fn clone(&self) -> SearchOutcome<P, S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P, S> Debug for SearchOutcome<P, S>
where P: Debug, S: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P, S> Eq for SearchOutcome<P, S>
where P: Eq, S: Eq,

Source§

impl From<InterpolatedSearchOutcome> for SearchOutcome<InterpolatedPathOutcome, InterpolatedSearchStats>

Source§

fn from( outcome: InterpolatedSearchOutcome, ) -> SearchOutcome<InterpolatedPathOutcome, InterpolatedSearchStats>

Converts to this type from the input type.
Source§

impl From<SearchOutcome<InterpolatedPathOutcome, InterpolatedSearchStats>> for InterpolatedSearchOutcome

Source§

fn from( outcome: SearchOutcome<InterpolatedPathOutcome, InterpolatedSearchStats>, ) -> InterpolatedSearchOutcome

Converts to this type from the input type.
Source§

impl<P, S> PartialEq for SearchOutcome<P, S>
where P: PartialEq, S: PartialEq,

Source§

fn eq(&self, other: &SearchOutcome<P, S>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<P, S> StructuralPartialEq for SearchOutcome<P, S>
where P: PartialEq, S: PartialEq,

Auto Trait Implementations§

§

impl<P, S> Freeze for SearchOutcome<P, S>
where P: Freeze, S: Freeze,

§

impl<P, S> RefUnwindSafe for SearchOutcome<P, S>

§

impl<P, S> Send for SearchOutcome<P, S>
where P: Send, S: Send,

§

impl<P, S> Sync for SearchOutcome<P, S>
where P: Sync, S: Sync,

§

impl<P, S> Unpin for SearchOutcome<P, S>
where P: Unpin, S: Unpin,

§

impl<P, S> UnsafeUnpin for SearchOutcome<P, S>
where P: UnsafeUnpin, S: UnsafeUnpin,

§

impl<P, S> UnwindSafe for SearchOutcome<P, S>
where P: UnwindSafe, S: 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

Source§

fn vzip(self) -> V

Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool