Enum h3ron_graph::algorithm::path::DirectedEdgePath

pub enum DirectedEdgePath {
    OriginIsDestination(H3Cell),
    DirectedEdgeSequence(Vec<H3DirectedEdge>),
}

DirectedEdgePath describes a path between a cell and another.

Variants

OriginIsDestination(H3Cell)

path is empty as origin and destination are the same.

DirectedEdgeSequence(Vec<H3DirectedEdge>)

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.

Implementations

impl DirectedEdgePath

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 edges(&self) -> &[H3DirectedEdge]

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

return a vec of all H3Cell the path passes through.

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

calculate the length of the path in meters using the exact length of the contained edges

Trait Implementations

impl Clone for DirectedEdgePath

fn clone(&self) -> DirectedEdgePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectedEdgePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectedEdgePath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for DirectedEdgePath

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DirectedEdgePath> for DirectedEdgePath

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

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

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

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

impl PartialOrd<DirectedEdgePath> for DirectedEdgePath

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 Serialize for DirectedEdgePath

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

Serialize this value into the given Serde serializer.

impl Eq for DirectedEdgePath

impl StructuralEq for DirectedEdgePath

impl StructuralPartialEq for DirectedEdgePath