Struct Cell 

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

HexTreeMap’s key type.

Implementations

impl Cell

pub const fn from_raw(raw: u64) -> Result<Self>

Constructs a new Cell from a raw u64 H3 index.

Errors

Returns an error if u64 is not a valid bit-representation of an H3 cell (mode 1 H3 index).

pub const fn into_raw(self) -> u64

Returns the raw u64 H3 index for this cell.

pub const fn to_parent(&self, res: u8) -> Option<Self>

Returns this cell’s parent at the specified resolution.

Returns Some if res is less-than or equal-to this cell’s resolution, otherwise returns None.

pub const fn res(&self) -> u8

Returns this cell’s resolution.

pub fn is_related_to(&self, other: &Self) -> bool

Returns true if self is related to other.

“Related” can be any of the following:

• self == other
• self is a parent cell of other
• other is a parent cell of self

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

H3 Index:

The canonical string representation of an H3Index is the hexadecimal representation of the integer, using lowercase letters. The string representation is variable length (no zero padding) and is not prefixed or suffixed.

impl<'de> Deserialize<'de> for Cell

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Cell

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

H3 Index:

The canonical string representation of an H3Index is the hexadecimal representation of the integer, using lowercase letters. The string representation is variable length (no zero padding) and is not prefixed or suffixed.

impl<'a> FromIterator<&'a Cell> for HexTreeSet

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = &'a Cell>,

Creates a value from an iterator.

impl FromIterator<Cell> for HexTreeSet

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Cell>,

Creates a value from an iterator.

impl Hash for Cell

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<V, C> Index<&Cell> for HexTreeMap<V, C>

fn index(&self, cell: &Cell) -> &V

Returns a reference to the value corresponding to the supplied key.

Examples

use hextree::{Cell, HexTreeMap};

let mut map = HexTreeMap::new();
let eiffel_tower_res12 = Cell::from_raw(0x8c1fb46741ae9ff)?;

map.insert(eiffel_tower_res12, "France");
assert_eq!(map[&eiffel_tower_res12], "France");

Panics

Panics if the cell is not present in the HexTreeMap.

type Output = V

The returned type after indexing.

impl<V, C> Index<Cell> for HexTreeMap<V, C>

fn index(&self, cell: Cell) -> &V

Returns a reference to the value corresponding to the supplied key.

Examples

use hextree::{Cell, HexTreeMap};

let mut map = HexTreeMap::new();
let eiffel_tower_res12 = Cell::from_raw(0x8c1fb46741ae9ff)?;

map.insert(eiffel_tower_res12, "France");
assert_eq!(map[eiffel_tower_res12], "France");

Panics

Panics if the cell is not present in the HexTreeMap.

type Output = V

The returned type after indexing.

impl<V, C> IndexMut<&Cell> for HexTreeMap<V, C>

fn index_mut(&mut self, cell: &Cell) -> &mut V

Returns a reference to the value corresponding to the supplied key.

Examples

use hextree::{Cell, HexTreeMap};

let mut map = HexTreeMap::new();
let eiffel_tower_res12 = Cell::from_raw(0x8c1fb46741ae9ff)?;

map.insert(eiffel_tower_res12, "France");
assert_eq!(map[&eiffel_tower_res12], "France");

map[&eiffel_tower_res12] = "Paris";
assert_eq!(map[&eiffel_tower_res12], "Paris");

Panics

Panics if the cell is not present in the HexTreeMap.

impl<V, C> IndexMut<Cell> for HexTreeMap<V, C>

fn index_mut(&mut self, cell: Cell) -> &mut V

Returns a reference to the value corresponding to the supplied key.

Examples

use hextree::{Cell, HexTreeMap};

let mut map = HexTreeMap::new();
let eiffel_tower_res12 = Cell::from_raw(0x8c1fb46741ae9ff)?;

map.insert(eiffel_tower_res12, "France");
assert_eq!(map[eiffel_tower_res12], "France");

map[eiffel_tower_res12] = "Paris";
assert_eq!(map[eiffel_tower_res12], "Paris");

Panics

Panics if the cell is not present in the HexTreeMap.

impl PartialEq for Cell

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Cell

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i64> for Cell

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: i64) -> Result<Cell>

Performs the conversion.

impl TryFrom<u64> for Cell

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: u64) -> Result<Cell>

Performs the conversion.

impl Copy for Cell

impl Eq for Cell

impl StructuralPartialEq for Cell