Enum h3ron_graph::algorithm::path::Path

pub enum Path<W> {
    OriginIsDestination(H3Cell, W),
    EdgeSequence(Vec<H3Edge>, W),
}

Path describes a path between a cell and another.

Variants

OriginIsDestination(H3Cell, W)

path is empty as origin and destination are the same.

Tuple Fields of OriginIsDestination

0: H3Cell1: W

EdgeSequence(Vec<H3Edge>, W)

a sequence of edges describing the path.

The edges in the vec are expected to be consecutive.

The cost is the total cost summed for all of the edges.

Tuple Fields of EdgeSequence

0: Vec<H3Edge>1: W

Implementations

impl<W> Path<W>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Length of the path in number of edges

pub fn origin_cell(&self) -> Result<H3Cell, Error>

pub fn destination_cell(&self) -> Result<H3Cell, Error>

pub fn to_linestring(&self) -> Result<LineString<f64>, Error>

pub fn cost(&self) -> &W

pub fn edges(&self) -> &[H3Edge]

Trait Implementations

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

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

Returns a copy 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<W> PartialOrd<Path<W>> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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: Eq> Eq for Path<W>

impl<W> StructuralEq for Path<W>

impl<W> StructuralPartialEq for Path<W>