Trait h3ron::Index

pub trait Index: Sized + PartialEq + FromH3Index {
    // Required methods
    fn h3index(&self) -> H3Index;
    fn new(h3index: H3Index) -> Self;
    fn validate(&self) -> Result<(), Error>;

    // Provided methods
    fn resolution(&self) -> u8 { ... }
    fn is_valid(&self) -> bool { ... }
    fn direction(&self) -> H3Direction { ... }
    fn direction_checked(&self) -> Result<H3Direction, Error> { ... }
    fn direction_to_parent_resolution(
        &self,
        target_resolution: u8
    ) -> Result<H3Direction, Error> { ... }
}

Trait to handle types having a H3 Index like cells and edges

Required Methods

fn h3index(&self) -> H3Index

Get the u64 H3 Index address

fn new(h3index: H3Index) -> Self

create an index from the given u64.

No validation is performed.

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

Checks the validity of the index

Provided Methods

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

Panics

May panic if self is invalid or has a resolution of 0

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

Retrieves the direction of the current index

Errors

May fail if self is invalid or has a resolution of 0

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

Object Safety

This trait is not object safe.

Implementors

impl Index for H3Cell

impl Index for H3DirectedEdge