Struct Path

pub struct Path<W> {
    pub origin_cell: H3Cell,
    pub destination_cell: H3Cell,
    pub cost: W,
    pub directed_edge_path: DirectedEdgePath,
}

Path describes a path between a cell and another with an associated cost

Fields

origin_cell: H3Cell

The cell the path starts at.

This is the cell the path was calculated from. The actual start cell of the path may differ in case origin_cell is not directly connected to the graph

destination_cell: H3Cell

The cell the path ends at.

This is the cell the path was calculated to. The actual end cell of the path may differ in case destination_cell is not directly connected to the graph

cost: W

directed_edge_path: DirectedEdgePath

describes the path

Implementations

impl<W> Path<W>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Trait Implementations

impl<W: Clone> Clone for Path<W>

fn clone(&self) -> Path<W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W: Debug> Debug for Path<W>

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

Formats the value using the given formatter.

impl<'de, W> Deserialize<'de> for Path<W>

where W: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<W> Ord for Path<W>

where W: Ord,

order by cost, origin index and destination_index.

This ordering can used to bring Vecs of routes in a deterministic order to make them comparable

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<W: PartialEq> PartialEq for Path<W>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<W> PartialOrd for Path<W>

where W: Ord,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<W> Serialize for Path<W>

where W: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<W> TryFrom<(DirectedEdgePath, W)> for Path<W>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( (path_directed_edges, cost): (DirectedEdgePath, W), ) -> Result<Self, Self::Error>

Performs the conversion.

impl<W: Eq> Eq for Path<W>

impl<W> StructuralPartialEq for Path<W>