Struct h3ron::H3Edge

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

H3 Index representing an Unidirectional H3 edge

Implementations

impl H3Edge

pub fn is_edge_valid(&self) -> bool

pub fn edge_length_km(resolution: u8) -> f64

Gets the average length of an edge in kilometers at resolution

pub fn edge_length_m(resolution: u8) -> f64

Gets the average length of an edge in meters at resolution

pub fn exact_length_km(&self) -> f64

Retrieves the exact length of self in kilometers

pub fn exact_length_m(&self) -> f64

Retrieves the exact length of self in meters

pub fn exact_length_rads(&self) -> f64

Retrieves the exact length of self in radians

pub fn destination_index_unchecked(&self) -> H3Cell

Retrieves the destination H3 Cell of self

Returns

The built index may be invalid. Use the destination_index method for validity check.

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

Retrieves the destination H3 Cell of self

Returns

If the built index is invalid, returns an Error. Use the destination_index_unchecked to avoid error.

pub fn origin_index_unchecked(&self) -> H3Cell

Retrieves the origin H3 Cell of self

Returns

The built index may be invalid. Use the origin_index method for validity check.

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

Retrieves the origin H3 Cell of self

Returns

If the built index is invalid, returns an Error. Use the origin_index_unchecked to avoid error.

Trait Implementations

impl Clone for H3Edge

fn clone(&self) -> H3Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for H3Edge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for H3Edge

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

Deserialize this value from the given Serde deserializer.

impl FromH3Index for H3Edge

fn from_h3index(h3index: H3Index) -> Self

impl FromStr for H3Edge

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 H3Edge

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, 

Feeds a slice of this type into the given Hasher.

impl Index for H3Edge

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 is_parent_of(&self, other: &Self) -> bool

Checks if self is a parent of other

fn is_child_of(&self, other: &Self) -> bool

Checks if other is a parent of self

fn contains(&self, other: &Self) -> bool

Checks if self is a parent of other

fn get_parent(&self, parent_resolution: u8) -> Result<Self, Error>

Retrieves the parent index at parent_resolution.

fn get_parent_unchecked(&self, parent_resolution: u8) -> Self

Retrieves the parent index at parent_resolution.

fn get_children(&self, child_resolution: u8) -> Vec<Self>

Retrieves all children of self at resolution child_resolution

impl Ord for H3Edge

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

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

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

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

This method tests for !=.

impl PartialOrd<H3Edge> for H3Edge

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

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

Serialize this value into the given Serde serializer.

impl ToString for H3Edge

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<u64> for H3Edge

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 H3Edge

impl Eq for H3Edge

impl StructuralEq for H3Edge

impl StructuralPartialEq for H3Edge