Struct h3ron::Index [−][src]
a single H3 index
Implementations
impl Index
[src]
pub fn new(h3index: H3Index) -> Self
[src]
pub fn h3index(&self) -> H3Index
[src]
pub fn resolution(&self) -> u8
[src]
pub fn is_valid(&self) -> bool
[src]
pub fn is_parent_of(&self, other: &Index) -> bool
[src]
pub fn is_child_of(&self, other: &Index) -> bool
[src]
pub fn contains(&self, other: &Index) -> bool
[src]
pub fn get_parent(&self, parent_resolution: u8) -> Index
[src]
pub fn get_children(&self, child_resolution: u8) -> Vec<Index>
[src]
pub fn from_point(pt: &Point<f64>, h3_resolution: u8) -> Self
[src]
pub fn from_coordinate(c: &Coordinate<f64>, h3_resolution: u8) -> Self
[src]
pub fn is_neighbor_to(&self, other: &Self) -> bool
[src]
Checks if the current index and other
are neighbors.
pub fn k_ring(&self, k: u32) -> Vec<Index>
[src]
pub fn hex_ring(&self, k: u32) -> Result<Vec<Index>, Error>
[src]
pub fn k_ring_distances(&self, k_min: u32, k_max: u32) -> Vec<(u32, Index)>
[src]
pub fn hex_range_distances(
&self,
k_min: u32,
k_max: u32
) -> Result<Vec<(u32, Index)>, Error>
[src]
&self,
k_min: u32,
k_max: u32
) -> Result<Vec<(u32, Index)>, Error>
pub fn area(&self, area_units: AreaUnits) -> f64
[src]
exact area for a specific cell (hexagon or pentagon)
pub fn is_pentagon(&self) -> bool
[src]
determines if an H3 cell is a pentagon
pub fn get_base_cell(&self) -> u8
[src]
returns the base cell “number” (0 to 121) of the provided H3 cell
Trait Implementations
impl Clone for Index
[src]
impl Debug for Index
[src]
impl<'de> Deserialize<'de> for Index
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for Index
[src]
impl From<u64> for Index
[src]
impl FromIterator<Index> for H3CompactedVec
[src]
fn from_iter<T: IntoIterator<Item = Index>>(iter: T) -> Self
[src]
impl FromStr for Index
[src]
type Err = Error
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl Hash for Index
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Index
[src]
fn cmp(&self, other: &Index) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Index> for Index
[src]
impl PartialOrd<Index> for Index
[src]
fn partial_cmp(&self, other: &Index) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Serialize for Index
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for Index
[src]
impl StructuralPartialEq for Index
[src]
impl ToCoordinate for Index
[src]
fn to_coordinate(&self) -> Coordinate<f64>
[src]
the centroid coordinate of the h3 index
impl ToPolygon for Index
[src]
fn to_polygon(&self) -> Polygon<f64>
[src]
the polygon spanning the area of the index
impl ToString for Index
[src]
Auto Trait Implementations
impl RefUnwindSafe for Index
impl Send for Index
impl Sync for Index
impl Unpin for Index
impl UnwindSafe for Index
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,