Struct h3ron::Index

pub struct Index(_);

a single H3 index

Implementations

impl Index

pub fn new(h3index: H3Index) -> Self

create an index from the given u64.

No validation is performed - use the TryInto trait in case that is desired.

pub fn resolution(&self) -> u8

pub fn is_valid(&self) -> bool

Checks the validity of the index

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

Checks the validity of the index

pub fn is_parent_of(&self, other: &Index) -> bool

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

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

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

Retrieves the parent index at parent_resolution.

Returns

This method may fail if the parent_resolution is higher than current self resolution.

If you don’t want it to fail use get_parent_unchecked

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

Retrieves the parent index at parent_resolution.

Returns

This method may return an invalid Index if the parent_resolutionis higher than current self resolution.

Use get_parent for validity check.

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

pub fn from_point_unchecked(pt: &Point<f64>, h3_resolution: u8) -> Self

Build a new Index from a Point.

Returns

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

pub fn from_point(pt: &Point<f64>, h3_resolution: u8) -> Result<Self, Error>

Build a new Index from a Point.

Returns

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

pub fn from_coordinate_unchecked(c: &Coordinate<f64>, h3_resolution: u8) -> Self

Build a new Index from coordinates.

Returns

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

pub fn from_coordinate(
    c: &Coordinate<f64>,
    h3_resolution: u8
) -> Result<Self, Error>

Build a new Index from coordinates.

Returns

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

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

Checks if the current index and other are neighbors.

pub fn k_ring(&self, k: u32) -> Vec<Index>

pub fn hex_ring(&self, k: u32) -> Result<Vec<Index>, Error>

pub fn k_ring_distances(&self, k_min: u32, k_max: u32) -> Vec<(u32, Index)>

Retrieves indexes around self through K Rings.

Arguments

• k_min - the minimum k ring distance
• k_max - the maximum k ring distance

Returns

A Vec of (u32, Index) tuple is returned. The u32 value is the K Ring distance of the Index value.

pub fn hex_range_distances(
    &self,
    k_min: u32,
    k_max: u32
) -> Result<Vec<(u32, Index)>, Error>

pub fn distance_to(&self, other: &Self) -> i32

Retrieves the number of K Rings between self and other.

For distance in miles or kilometers use haversine algorithms.

pub fn area(&self, area_units: AreaUnits) -> f64

exact area for a specific cell (hexagon or pentagon)

pub fn is_pentagon(&self) -> bool

determines if an H3 cell is a pentagon

pub fn get_base_cell(&self) -> u8

returns the base cell “number” (0 to 121) of the provided H3 cell

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Index

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

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

Deserialize this value from the given Serde deserializer.

impl Eq for Index

impl FromH3Index for Index

fn from_h3index(h3index: H3Index) -> Self

impl FromIterator<Index> for H3CompactedVec

fn from_iter<T: IntoIterator<Item = Index>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Index

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 HasH3Index for Index

fn h3index(&self) -> H3Index

impl Hash for Index

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Index

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

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

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

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

This method tests for !=.

impl PartialOrd<Index> for Index

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Index

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Index

impl StructuralPartialEq for Index

impl ToCoordinate for Index

fn to_coordinate(&self) -> Coordinate<f64>

the centroid coordinate of the h3 index

impl ToIndex for Index

fn to_index(&self) -> Index

impl ToPolygon for Index

fn to_polygon(&self) -> Polygon<f64>

the polygon spanning the area of the index

impl ToString for Index

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<u64> for Index

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.