Skip to main content

Path

Struct Path 

Source
pub struct Path { /* private fields */ }
Expand description

Non-empty sequence of grid cells with an associated traversal cost.

Cost is hop-count (from_steps) or algorithm-supplied weighted cost (from_steps_with_cost). Paths do not validate adjacency on construction; callers use crate::Grid::path_is_walkable when geometry must be checked.

Implementations§

Source§

impl Path

Source

pub fn from_steps(steps: Vec<Point>) -> Result<Self, PathBuildError>

Builds a path with cost equal to steps.len() - 1 (unit hop model).

§Errors

Returns PathBuildError::Empty when steps is empty.

Source

pub fn from_steps_with_cost( steps: Vec<Point>, cost: usize, ) -> Result<Self, PathBuildError>

Builds a path with an explicit traversal cost (weighted solvers).

§Errors

Returns PathBuildError::Empty when steps is empty.

Source

pub fn steps(&self) -> &[Point]

Ordered cell sequence from start through goal (inclusive).

Source

pub fn len(&self) -> usize

Number of cell steps (always ≥ 1 for constructed paths).

Source

pub const fn is_empty(&self) -> bool

Always false for successfully constructed paths.

Source

pub fn cost(&self) -> usize

Hop count (from_steps) or algorithm-supplied traversal cost (from_steps_with_cost).

Source

pub fn start(&self) -> Point

First step; always defined because paths are non-empty by construction.

Source

pub fn goal(&self) -> Point

Last step; always defined because paths are non-empty by construction.

Trait Implementations§

Source§

impl Clone for Path

Source§

fn clone(&self) -> Path

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 Debug for Path

Source§

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

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

impl Eq for Path

Source§

impl PartialEq for Path

Source§

fn eq(&self, other: &Path) -> bool

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

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

Inequality operator !=. Read more
Source§

impl SearchPathCost for Path

Source§

type Cost = usize

Cost type used by this path family (for example f64 Euclidean length).
Source§

fn path_cost(&self) -> Self::Cost

Returns the path’s domain-specific traversal cost.
Source§

impl StructuralPartialEq for Path

Auto Trait Implementations§

§

impl Freeze for Path

§

impl RefUnwindSafe for Path

§

impl Send for Path

§

impl Sync for Path

§

impl Unpin for Path

§

impl UnsafeUnpin for Path

§

impl UnwindSafe for Path

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