DirectedEdgeIndex

Struct DirectedEdgeIndex 

Source
pub struct DirectedEdgeIndex(/* private fields */);
Expand description

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:

Implementations§

Source§

impl DirectedEdgeIndex

Source

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)?);
Source

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)?);
Source

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)?);
Source

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)?,
));
Source

pub fn boundary(self) -> Boundary

Returns the coordinates defining the directed edge.

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

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
);
Source

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
);
Source

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§

Source§

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

Source§

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

Generate an arbitrary value of Self from the given unstructured data. Read more
Source§

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

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
Source§

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. Read more
Source§

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. Read more
Source§

impl Binary for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Clone for DirectedEdgeIndex

Source§

fn clone(&self) -> DirectedEdgeIndex

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<DirectedEdgeIndex> for Line

Source§

fn from(value: DirectedEdgeIndex) -> Self

Converts to this type from the input type.
Source§

impl From<DirectedEdgeIndex> for u64

Source§

fn from(value: DirectedEdgeIndex) -> Self

Converts to this type from the input type.
Source§

impl FromStr for DirectedEdgeIndex

Source§

type Err = InvalidDirectedEdgeIndex

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for DirectedEdgeIndex

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LowerHex for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Octal for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for DirectedEdgeIndex

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for DirectedEdgeIndex

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for DirectedEdgeIndex

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Serialize for DirectedEdgeIndex

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<u64> for DirectedEdgeIndex

Source§

type Error = InvalidDirectedEdgeIndex

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl UpperHex for DirectedEdgeIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for DirectedEdgeIndex

Source§

impl Eq for DirectedEdgeIndex

Source§

impl StructuralPartialEq for DirectedEdgeIndex

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,