Struct FIPSCode 

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

Encodes a hierarchical FIPS geographic region code in 64 bits. Excludes the nonhierarchical codes places, congressional or state legislative districts, and ZIP code tabulation areas. (See the module level documentation.)

Implementations

impl FIPSCode

pub fn with_state(state: USState) -> Self

Constructs a new FIPSCode from a USState. Unlike the other constructors, this constructor is infallible.

pub fn with_state_code(state_code: StateCode) -> Result<Self, FIPSError>

Constructs a new FIPSCode. Returns Err(()) if the data provided is out of range.

pub fn with_county( state: StateCode, county: CountyCode, ) -> Result<Self, FIPSError>

Constructs a new FIPSCode. Returns Err(()) if the data provided is out of range.

pub fn with_tract( state: StateCode, county: CountyCode, tract: TractCode, ) -> Result<Self, FIPSError>

Constructs a new FIPSCode. Returns Err(()) if the data provided is out of range.

pub fn with_category( state: StateCode, county: CountyCode, tract: TractCode, category: SettingCategoryCode, ) -> Result<Self, FIPSError>

Constructs a new FIPSCode. Returns Err(()) if the data provided is out of range.

pub fn new( state: StateCode, county: CountyCode, tract: TractCode, category: SettingCategoryCode, id: IdCode, data: DataCode, ) -> Result<Self, FIPSError>

pub fn state(&self) -> Result<USState, FIPSError>

Returns the FIPS STATE as a USState enum variant. Returns Err(()) if USState cannot represent the state code. Use FIPSCode::state_code() to retrieve the state code in this case.

pub fn state_code(&self) -> StateCode

Returns the FIPS STATE code as a StateCode (a u8)

pub fn county_code(&self) -> CountyCode

Returns the numeric FIPS COUNTY code

pub fn census_tract_code(&self) -> TractCode

Returns the numeric FIPS CENSUS TRACT code

pub fn category_code(&self) -> SettingCategoryCode

Returns the numeric SETTING CATEGORY code

pub fn id(&self) -> IdCode

Returns the monotonically increasing ID number as an IdCode

pub fn data(&self) -> DataCode

Returns the unused data region occupying the 9 LSB

pub fn set_state(&self, state: USState) -> Self

Creates a copy of self with the FIPS STATE set to state.

pub fn set_state_code(&self, state_code: StateCode) -> Result<Self, FIPSError>

Creates a copy of self with the FIPS STATE set to state.

pub fn set_county(&self, county: CountyCode) -> Result<Self, FIPSError>

Creates a copy of self with the FIPS COUNTY set to county.

pub fn set_tract(&self, tract: TractCode) -> Result<Self, FIPSError>

Creates a copy of self with the FIPS CENSUS TRACT set to tract.

pub fn set_category( &self, category: SettingCategoryCode, ) -> Result<Self, FIPSError>

Creates a copy of self with the setting category set to category.

pub fn set_id(&self, id: IdCode) -> Result<Self, FIPSError>

Creates a copy of self with the ID number set to id.

pub fn set_data(&self, data: DataCode) -> Result<Self, FIPSError>

Creates a copy of self with the unused data region set to data.

pub fn set_data_in_place(&mut self, data: DataCode) -> Result<(), FIPSError>

Sets the unused data region occupying the 10 LSB in place. Returns Ok(()) if data is in range, Err(FIPSError) otherwise.

pub fn compare_non_data(&self, other: Self) -> Ordering

Compares the given values without respect to the data region (the Least Significant Bits). Use the usual equality operators for comparing FIPSCodes including the data region.

Trait Implementations

impl Clone for FIPSCode

fn clone(&self) -> FIPSCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FIPSCode

impl Debug for FIPSCode

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

Format the code as a string of hex digits with fields separated by dashes. Note that this is different from serializing to the original FIPS code encoding. Use format_as_fips_code/format_as_fips_code for that purpose.

impl Display for FIPSCode

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

Formats the value using the given formatter.

impl Eq for FIPSCode

impl Hash for FIPSCode

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 Ord for FIPSCode

fn cmp(&self, other: &FIPSCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FIPSCode

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

fn partial_cmp(&self, other: &FIPSCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FIPSCode