CensusClient

Struct CensusClient 

Source
pub struct CensusClient { /* private fields */ }
Expand description

Client for US Census Bureau API

Provides access to:

  • Decennial Census data
  • American Community Survey (ACS)
  • Economic indicators
  • Population estimates

§Example

use ruvector_data_framework::CensusClient;

let client = CensusClient::new(None);
let population = client.get_population(2020, "state:*").await?;
let acs_data = client.get_acs5(2021, vec!["B01001_001E"], "county:*").await?;
let datasets = client.get_available_datasets().await?;

Implementations§

Source§

impl CensusClient

Source

pub fn new(api_key: Option<String>) -> Self

Create a new Census Bureau client

§Arguments
  • api_key - Optional Census API key (500 req/day without key, unlimited with key) Get key at: https://api.census.gov/data/key_signup.html
Source

pub fn with_config( api_key: Option<String>, embedding_dim: usize, use_mock: bool, ) -> Self

Create a new Census client with custom configuration

§Arguments
  • api_key - Optional Census API key
  • embedding_dim - Dimension for embeddings
  • use_mock - Use mock data when API is unavailable
Source

pub async fn get_population( &self, year: u32, geography: &str, ) -> Result<Vec<SemanticVector>>

Get population data for a specific year and geography

§Arguments
  • year - Census year (e.g., 2020, 2010)
  • geography - Geography filter (e.g., “state:*”, “county:06”, “us:1”)
§Example
// Get all states population
let pop = client.get_population(2020, "state:*").await?;

// Get California counties
let ca_counties = client.get_population(2020, "county:*&in=state:06").await?;
Source

pub async fn get_acs5( &self, year: u32, variables: Vec<&str>, geography: &str, ) -> Result<Vec<SemanticVector>>

Get American Community Survey 5-year estimates

§Arguments
  • year - Survey year (2009-2021+)
  • variables - Variable codes (e.g., [“B01001_001E”] for total population)
  • geography - Geography filter
§Example
// Get median household income for all states
let income = client.get_acs5(
    2021,
    vec!["B19013_001E"],
    "state:*"
).await?;
Source

pub async fn get_available_datasets(&self) -> Result<Vec<SemanticVector>>

Get available Census datasets

§Example
let datasets = client.get_available_datasets().await?;
for ds in datasets {
    println!("Dataset: {}", ds.metadata.get("title").unwrap());
}
Source

pub async fn search_variables( &self, dataset: &str, query: &str, ) -> Result<Vec<SemanticVector>>

Search for variables in a dataset

§Arguments
  • dataset - Dataset identifier (e.g., “acs/acs5”, “dec/pl”)
  • query - Search query for variable names/labels
§Example
let vars = client.search_variables("acs/acs5", "income").await?;

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more