Struct h3ron::H3DirectedEdge

#[repr(transparent)]
pub struct H3DirectedEdge(_);

H3 Index representing an directed H3 edge

Implementations

impl H3DirectedEdge

pub fn from_cells(
    origin_cell: H3Cell,
    destination_cell: H3Cell
) -> Result<Self, Error>

Gets the unidirectional edge from origin_cell to destination_cell

pub fn is_edge_valid(&self) -> bool

pub fn edge_length_avg_km(resolution: u8) -> Result<f64, Error>

Gets the average length of an edge in kilometers at resolution. This is the length of the cell boundary segment represented by the edge.

pub fn edge_length_avg_m(resolution: u8) -> Result<f64, Error>

Gets the average length of an edge in meters at resolution. This is the length of the cell boundary segment represented by the edge.

pub fn cell_centroid_distance_avg_m_at_resolution(
    resolution: u8
) -> Result<f64, Error>

The approximate distance between the centroids of two neighboring cells at the given resolution.

Based on the approximate edge length. See H3DirectedEdge::cell_centroid_distance_m for a more exact variant of this function.

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

The approximate distance between the centroids of two neighboring cells at the given resolution.

Based on the exact edge length. See H3DirectedEdge::cell_centroid_distance_avg_m_at_resolution for a resolution based variant.

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

Retrieves the destination H3 Cell of self

Returns

If the built index is invalid, returns an Error.

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

Retrieves the origin H3 Cell of self

Returns

If the built index is invalid, returns an Error.

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

Retrieves a H3EdgeCells of the origin and destination cell of the edge.

Returns

If the built indexes are invalid, returns an Error.

pub fn reversed(&self) -> Result<Self, Error>

Retrieves the corresponding edge in the reversed direction.

Returns

If the built edge is invalid, returns an Error.

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

Retrieves the LineString which forms the boundary between two cells.

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

Retrieves the exact length of self in meters This is the length of the cell boundary segment represented by the edge.

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

Retrieves the exact length of self in kilometers This is the length of the cell boundary segment represented by the edge.

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

Retrieves the exact length of self in radians This is the length of the cell boundary segment represented by the edge.

Trait Implementations

impl Clone for H3DirectedEdge

fn clone(&self) -> H3DirectedEdge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for H3DirectedEdge

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

Formats the value using the given formatter.

impl Deref for H3DirectedEdge

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for H3DirectedEdge

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

Deserialize this value from the given Serde deserializer.

impl FromH3Index for H3DirectedEdge

fn from_h3index(h3index: H3Index) -> Self

impl FromStr for H3DirectedEdge

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for H3DirectedEdge

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index for H3DirectedEdge

fn h3index(&self) -> H3Index

Get the u64 H3 Index address

fn new(h3index: H3Index) -> Self

create an index from the given u64.

fn validate(&self) -> Result<(), Error>

Checks the validity of the index

fn resolution(&self) -> u8

Gets the index resolution (0-15)

fn is_valid(&self) -> bool

Checks the validity of the index

fn direction(&self) -> H3Direction

Retrieves the direction of the current index

fn direction_checked(&self) -> Result<H3Direction, Error>

Retrieves the direction of the current index

fn direction_to_parent_resolution(
    &self,
    target_resolution: u8
) -> Result<H3Direction, Error>

Retrieves the direction of the current index relative to a parent at target_resolution

impl Ord for H3DirectedEdge

fn cmp(&self, other: &H3DirectedEdge) -> 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<H3DirectedEdge> for H3DirectedEdge

fn eq(&self, other: &H3DirectedEdge) -> 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<H3DirectedEdge> for H3DirectedEdge

fn partial_cmp(&self, other: &H3DirectedEdge) -> 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 H3DirectedEdge

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

Serialize this value into the given Serde serializer.

impl ToLine for H3DirectedEdge

fn to_line(&self) -> Result<Line<f64>, Self::Error>

Create a line geometry from the origin index to the destination index

use h3ron::{H3DirectedEdge, Index};
use h3ron::to_geo::{ToLine, ToCoordinate};

let edge = H3DirectedEdge::new(0x149283080ddbffff);
let l = edge.to_line().unwrap();
assert_eq!(l.start, edge.origin_cell().unwrap().to_coordinate().unwrap());
assert_eq!(l.end, edge.destination_cell().unwrap().to_coordinate().unwrap());

type Error = Error

impl ToLineString for H3DirectedEdge

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

Create a linestring from the origin index to the destination index

use h3ron::{H3DirectedEdge, Index};
use h3ron::to_geo::{ToLineString, ToCoordinate};

let edge = H3DirectedEdge::new(0x149283080ddbffff);
let ls = edge.to_linestring().unwrap();
assert_eq!(ls.0.len(), 2);
assert_eq!(ls.0[0], edge.origin_cell().unwrap().to_coordinate().unwrap());
assert_eq!(ls.0[1], edge.destination_cell().unwrap().to_coordinate().unwrap());

type Error = Error

impl ToString for H3DirectedEdge

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<u64> for H3DirectedEdge

convert to index including validation

type Error = Error

The type returned in the event of a conversion error.

fn try_from(h3index: H3Index) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for H3DirectedEdge

impl Eq for H3DirectedEdge

impl StructuralEq for H3DirectedEdge

impl StructuralPartialEq for H3DirectedEdge