Struct BinaryHash

pub struct BinaryHash { /* private fields */ }

Binary hash code for a given GeoLocation with specific precision

Implementations

impl BinaryHash

pub fn new() -> BinaryHash

Create an empty BinaryHash

pub fn from_string(s: &str) -> BinaryHash

Create a BinaryHash from a String

Example

let bh=geohashrust::BinaryHash::from_string("11100110");
assert_eq!(bh.to_string(), "11100110");

pub fn encode(l: &GeoLocation, precision: u8) -> BinaryHash

Encode a GeoLocation into binary hash

Example

let l=geohashrust::GeoLocation{
        latitude:31.23,
        longitude:121.473,
};
let bh=geohashrust::BinaryHash::encode(&l, 8);
assert_eq!(bh.to_string(), "11100110");

pub fn decode(&self) -> BoundingBox

Decode binary hash into a BoundingBox

Example

let bh=geohashrust::BinaryHash::from_string("11100");
let bbox=bh.decode();
assert!(bbox.contains(&geohashrust::GeoLocation::from_coordinates(21.0, 113.0)));

pub fn decode_string(s: &str) -> BoundingBox

Decode binary hash into a BoundingBox

Example

let bbox=geohashrust::BinaryHash::decode_string("11100");
assert!(bbox.contains(&geohashrust::GeoLocation::from_coordinates(21.0, 113.0)));

pub fn to_string(&self) -> String

Convert BinaryHash to a String

Example

let bh=geohashrust::BinaryHash::from_string("11100110");
assert_eq!(bh.to_string(), "11100110");

pub fn len(&self) -> u8

Return the count of effective bits in the binary hash

Example

let mut bh=geohashrust::BinaryHash::new();
assert_eq!(bh.len(), 0);
bh.push(true);
bh.push(true);
assert_eq!(bh.len(), 2);
bh.push(false);
bh.push(true);
assert_eq!(bh.len(), 4);

pub fn empty(&self) -> bool

Test if the binary hash is empty

Example

let mut bh=geohashrust::BinaryHash::new();
assert!(bh.empty());
bh.push(true);
bh.push(true);
bh.push(false);
bh.push(true);
assert!(!bh.empty());

pub fn test(&self, n: u8) -> bool

Test specific bit of the binary hash

Example

let mut bh=geohashrust::BinaryHash::new();
bh.push(true);
bh.push(true);
bh.push(false);
bh.push(true);
assert!(bh.test(0));
assert!(bh.test(1));
assert!(!bh.test(2));
assert!(bh.test(3));

pub fn push(&mut self, b: bool)

Push a bit into binary hash

Example

let mut bh=geohashrust::BinaryHash::new();
bh.push(true);
bh.push(true);
bh.push(false);
bh.push(true);
assert_eq!(bh.to_string(), "1101");

Trait Implementations

impl Clone for BinaryHash

fn clone(&self) -> BinaryHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BinaryHash

fn default() -> BinaryHash

Returns the “default value” for a type.

impl PartialEq for BinaryHash

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

impl StructuralPartialEq for BinaryHash