Enum Geoid 

pub enum Geoid {
    State(State),
    County(State, County),
    CountySubdivision(State, County, CountySubdivision),
    Place(State, Place),
    CensusTract(State, County, CensusTract),
    BlockGroup(State, County, CensusTract, BlockGroup),
    Block(State, County, CensusTract, Block),
}

Variants

State(State)

County(State, County)

CountySubdivision(State, County, CountySubdivision)

Place(State, Place)

CensusTract(State, County, CensusTract)

BlockGroup(State, County, CensusTract, BlockGroup)

Block(State, County, CensusTract, Block)

Implementations

impl Geoid

pub fn all_states() -> Vec<Geoid>

generates all state level Geoids for the U.S.

pub fn geoid_type(&self) -> GeoidType

pub fn variant_name(&self) -> String

pub fn truncate_geoid_to_type( &self, target: &GeoidType, ) -> Result<Geoid, String>

manipulates this GEOID via truncation to transform it’s GEOID type.

GEOID is a hierarchical numeric identifier. we can truncate the values in order to reach a higher/larger geographic representation. this method supports that operation, where this Geoid instance will be truncated to transform it into some other GeoidType.

Examples

converts GEOID 08059009838 (TRACT) to 08059 (COUNTY).

use bamcensus_core::model::identifier::{Geoid, GeoidType, fips};
let geoid = Geoid::CensusTract(
    fips::State(8),         // 08     Colorado
    fips::County(59),       // 059    Jefferson
    fips::CensusTract(9838) // 009838
);
let result = geoid.truncate_geoid_to_type(&GeoidType::County).unwrap();
assert_eq!(result, Geoid::County(fips::State(8), fips::County(59)))

pub fn is_parent_of(&self, child: &Geoid) -> bool

predicate to filter by hierarchical geoshed.

pub fn to_parent(&self) -> Option<Geoid>

manipulates this GEOID via truncation to transform it’s GEOID type to that of it’s parent.

the base case is None, which is the parent of State, and signifies “no restriction” in census queries. for all other GeoidTypes, we simply remove the lowest area type.

Note

Geoid::Block.to_parent() produces a CensusTract, not a BlockGroup, based on https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html, which does not imply that all block groups are the first digit of all blocks.

pub fn to_state(&self) -> Geoid

pub fn to_state_abbreviation(&self) -> Result<String, String>

pub fn to_county(&self) -> Result<Geoid, String>

pub fn to_census_tract(&self) -> Result<Geoid, String>

Trait Implementations

impl Clone for Geoid

fn clone(&self) -> Geoid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Geoid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Geoid

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Geoid

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

Formats the value using the given formatter.

impl Eq for Geoid

impl HasGeoidString for Geoid

fn geoid_string(&self) -> String

impl Hash for Geoid

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 Geoid

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Geoid

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Geoid

impl TryFrom<&str> for Geoid

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Geoid> for StateCode

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.