Struct NodeLocation 

pub struct NodeLocation { /* private fields */ }

A variable-precision geographic location encoded as a 1–7 byte grid code.

Each byte refines the location to a 16×16 sub-grid. Within each byte, the high nibble indexes longitude and the low nibble indexes latitude. All (longitude, latitude) tuples in this type use that order.

The zero-length UNSPECIFIED sentinel represents an unknown location.

Implementations

impl NodeLocation

pub const UNSPECIFIED: NodeLocation

An unspecified location with zero-byte precision.

pub fn from_bytes(bytes: &[u8]) -> Self

Construct from a byte slice, silently truncating to MAX_PRECISION. Never panics.

pub fn from_lat_lon(lon: f32, lat: f32, precision: u8) -> Self

Encode a (longitude, latitude) position in degrees at the given precision.

precision is clamped to MAX_PRECISION. Inputs are clamped to valid ranges ([-180, +180] and [-90, +90]).

Internal arithmetic uses f32 by default. Enable the f64 crate feature for accurate results at 6–7 byte precision.

pub fn from_lat_lon_f64(lon: f64, lat: f64, precision: u8) -> Self

Encode a (longitude, latitude) position in degrees at the given precision.

Only available with the f64 crate feature. Prefer this over from_lat_lon when working with f64 coordinates and 6–7 byte precision.

pub fn as_bytes(&self) -> &[u8]

The raw encoded bytes.

pub fn len(&self) -> usize

Number of encoded bytes (0 if unspecified).

pub fn is_unspecified(&self) -> bool

Returns true if this location is unspecified (zero-byte precision).

pub fn precision(&self) -> u8

Precision level (0–7). Zero means unspecified.

pub fn clamped(&self, precision: u8) -> Self

Return a copy truncated to at most precision bytes.

Because the encoding is strictly hierarchical, the truncated value is the correct encoding of the same position at the lower precision.

pub fn bounds(&self) -> ((f32, f32), (f32, f32))

The grid cell as ((lon_min, lat_min), (lon_max, lat_max)), in degrees.

Cell bounds are half-open [lo, hi), matching the floor-based encoding. An unspecified location returns the full globe ((-180, -90), (180, 90)).

pub fn center(&self) -> (f32, f32)

Center of the encoded grid cell as (longitude, latitude), in degrees.

pub fn contains(&self, lon: f32, lat: f32) -> bool

Returns true if (longitude, latitude) falls within this cell.

An unspecified location contains all points.

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

Returns true if other is the same cell or a sub-cell of this one.

An unspecified location contains everything. A finer location cannot contain a coarser one.

Trait Implementations

impl Clone for NodeLocation

fn clone(&self) -> NodeLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeLocation

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

Formats the value using the given formatter.

impl Default for NodeLocation

fn default() -> Self

Returns the “default value” for a type.

impl Display for NodeLocation

Displays as "longitude, latitude" with decimal places matched to the encoded precision.

An unspecified location displays as "(unspecified)".

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

Formats the value using the given formatter.

impl From<(f32, f32)> for NodeLocation

Encodes a (longitude, latitude) pair at maximum precision (7 bytes).

fn from((lon, lat): (f32, f32)) -> Self

Converts to this type from the input type.

impl From<(f64, f64)> for NodeLocation

Available on crate feature f64 only.

Encodes a (longitude, latitude) pair at maximum precision (7 bytes).

Only available with the f64 crate feature.

fn from((lon, lat): (f64, f64)) -> Self

Converts to this type from the input type.

impl From<NodeLocation> for (f32, f32)

Converts to the (longitude, latitude) center of the cell.

fn from(loc: NodeLocation) -> Self

Converts to this type from the input type.

impl Hash for NodeLocation

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 PartialEq for NodeLocation

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

impl Eq for NodeLocation

impl StructuralPartialEq for NodeLocation