Struct DirectedEdgeIndex 

pub struct DirectedEdgeIndex(/* private fields */);

Represents a single directed edge between two cells (an “origin” cell and a neighboring “destination” cell).

The index is encoded on 64-bit with the following bit layout:

 ┏━┳━━━┳━━━┳━━━━━━━━━━━━━━━━━━━━━━┈┈┈┈┈┈┈┈━━━━━━━┓
 ┃U┃ M ┃ E ┃                O                    ┃
 ┗━┻━━━┻━━━┻━━━━━━━━━━━━━━━━━━━━━━┈┈┈┈┈┈┈┈━━━━━━━┛
64 63 59   56                                    0

Where:

• U is an unused reserved bit, always set to 0 (bit 63).
• M is the index mode, always set to 2, coded on 4 bits (59-62).
• E is the edge of the origin cell, in [1; 6], coded on 3 bits (56-58).
• O is the origin cell index, coded on 56 bits (0-55).

References:

• H3 Index Representations
• H3 Index Bit Layout
• H3 Index Inspector

Implementations

impl DirectedEdgeIndex

pub fn reverse(self) -> Self

Returns the directed edge with origin and destination cells reversed.

pub fn edge(self) -> Edge

Returns the cell edge.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
assert_eq!(index.edge(), h3o::Edge::try_from(3)?);

pub fn origin(self) -> CellIndex

Returns the origin hexagon from the directed edge index.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
assert_eq!(index.origin(), h3o::CellIndex::try_from(0x8a194e699ab7fff)?);

pub fn destination(self) -> CellIndex

Returns the destination hexagon from the directed edge index.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a1_94e6_99ab_7fff)?;
assert_eq!(index.destination(), h3o::CellIndex::try_from(0x8a194e699a97fff)?);

pub fn cells(self) -> (CellIndex, CellIndex)

Returns the (origin, destination) pair of cell index for this edge.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a1_94e6_99ab_7fff)?;
assert_eq!(index.cells(), (
    h3o::CellIndex::try_from(0x8a194e699ab7fff)?,
    h3o::CellIndex::try_from(0x8a194e699a97fff)?,
));

pub fn boundary(self) -> Boundary

Returns the coordinates defining the directed edge.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
let boundary = index.boundary();

pub fn length_rads(self) -> f64

Computes the length of this directed edge, in radians.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
float_eq::assert_float_eq!(
    index.length_rads(),
    1.1795418098325597e-5,
    abs <= 1e-11
);

pub fn length_km(self) -> f64

Computes the length of this directed edge, in kilometers.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
float_eq::assert_float_eq!(
    index.length_km(),
    0.07514869340636812,
    abs <= 1e-11
);

pub fn length_m(self) -> f64

Computes the length of this directed edge, in meters.

Example

let index = h3o::DirectedEdgeIndex::try_from(0x13a194e699ab7fff)?;
float_eq::assert_float_eq!(
    index.length_m(),
    75.14869340636812,
    abs <= 1e-8
);

Trait Implementations

impl<'a> Arbitrary<'a> for DirectedEdgeIndex

Available on crate feature arbitrary only.

fn arbitrary(data: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Binary for DirectedEdgeIndex

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

Formats the value using the given formatter.

impl Clone for DirectedEdgeIndex

fn clone(&self) -> DirectedEdgeIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DirectedEdgeIndex

impl Debug for DirectedEdgeIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectedEdgeIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DirectedEdgeIndex

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

Formats the value using the given formatter.

impl Eq for DirectedEdgeIndex

impl From<DirectedEdgeIndex> for u64

fn from(value: DirectedEdgeIndex) -> Self

Converts to this type from the input type.

impl From<DirectedEdgeIndex> for Line

Available on crate feature geo only.

fn from(value: DirectedEdgeIndex) -> Self

Converts to this type from the input type.

impl FromStr for DirectedEdgeIndex

type Err = InvalidDirectedEdgeIndex

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 DirectedEdgeIndex

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 LowerHex for DirectedEdgeIndex

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

Formats the value using the given formatter.

impl Octal for DirectedEdgeIndex

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

Formats the value using the given formatter.

impl Ord for DirectedEdgeIndex

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DirectedEdgeIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DirectedEdgeIndex

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DirectedEdgeIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DirectedEdgeIndex

impl TryFrom<u64> for DirectedEdgeIndex

type Error = InvalidDirectedEdgeIndex

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for DirectedEdgeIndex

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

Formats the value using the given formatter.