Enum h3ron::H3Direction

pub enum H3Direction {
    CenterDigit,
    KAxesDigit,
    JAxesDigit,
    JkAxesDigit,
    IAxesDigit,
    IkAxesDigit,
    IjAxesDigit,
}

H3 digit representing ijk+ axes direction. See documentation

           j Axis
           ___
          /   \
      +--+  2  +--+
     / 3  \___/  6 \
     \    /   \    /
      +--+  0  +--+
     /    \___/    \
     \ 1  /   \  4 /
      +--+  5  +--+   i Axis
k Axis    \___/

Variants

CenterDigit

H3 digit in center

KAxesDigit

H3 digit in k-axes direction

JAxesDigit

H3 digit in j-axes direction

JkAxesDigit

H3 digit in j==k direction

IAxesDigit

H3 digit in i-axes direction

IkAxesDigit

H3 digit in i==k direction

IjAxesDigit

H3 digit in i==j direction

Implementations

impl H3Direction

pub fn direction_to_parent<I: Index>(index: &I) -> Result<Self, Error>

Retrieves the H3 Direction of the index relative to its direct parent

Errors

May fail if the direction is invalid. This can be caused by trying to retrieve a direction for:

• an index of 0 resolution
• an invalid index

pub fn direction<I: Index>(index: &I) -> Result<Self, Error>

Retrieves the H3 Direction of the index

Errors

May fail if the direction is invalid. This can be caused by trying to retrieve a direction for:

• an index of 0 resolution
• an invalid index

pub fn direction_to_parent_resolution<I: Index>(
    index: &I,
    target_resolution: u8
) -> Result<Self, Error>

Retrieves the H3 Direction of the index relative to its parent at target_resolution.

The function may fail if target_resolution is higher than index resolution

pub fn iter_directions_over_resolutions<I: Index>(
    index: &I
) -> ResolutionDirectionIter

iterate over all directions leading to the given index starting from resolution 0 to the resolution of the index.

Trait Implementations

impl Clone for H3Direction

fn clone(&self) -> H3Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for H3Direction

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

Formats the value using the given formatter.

impl Hash for H3Direction

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 Ord for H3Direction

fn cmp(&self, other: &H3Direction) -> 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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<H3Direction> for H3Direction

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

fn partial_cmp(&self, other: &H3Direction) -> 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 TryFrom<u8> for H3Direction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for H3Direction

impl Eq for H3Direction

impl StructuralEq for H3Direction

impl StructuralPartialEq for H3Direction