SocrataClient

Struct SocrataClient 

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

A client for the Socrata Open Data API (SODA).

Implementations§

Source§

impl SocrataClient

Source

pub fn new(base_url: &str, app_token: Option<String>) -> Self

Creates a new SocrataClient.

§Arguments
  • base_url - The base domain of the Socrata instance (e.g., “https://www.datos.gov.co”)
  • app_token - Optional Socrata App Token for higher rate limits.
Source

pub async fn fetch<T: DeserializeOwned>( &self, dataset_id: &str, limit: u32, offset: u32, order: Option<&str>, where_clause: Option<&str>, ) -> Result<Vec<T>, SocrataError>

Fetch data from a specific dataset ID using SODA API.

§Arguments
  • dataset_id - The 4x4 ID of the dataset (e.g. “jbjy-vk9h”)
  • limit - Number of records to return
  • offset - Number of records to skip
  • order - SoQL order clause (e.g. “date DESC”)
  • where_clause - Optional SoQL where clause
Source

pub async fn get_all<T: DeserializeOwned>( &self, dataset_id: &str, order: Option<&str>, where_clause: Option<&str>, ) -> Result<Vec<T>, SocrataError>

Fetch ALL data from a dataset, automatically paginating through results.

This method handles pagination internally and returns all records. For very large datasets, consider using fetch() with explicit pagination.

§Arguments
  • dataset_id - The 4x4 ID of the dataset
  • order - Optional SoQL order clause
  • where_clause - Optional SoQL where clause
Source

pub async fn get_metadata( &self, dataset_id: &str, ) -> Result<DatasetMetadata, SocrataError>

Retrieve metadata about a specific dataset.

§Arguments
  • dataset_id - The 4x4 ID of the dataset
Source

pub async fn datasets( &self, limit: u32, offset: u32, ) -> Result<Vec<CatalogResource>, SocrataError>

List all datasets in the domain.

Uses the Socrata Catalog API to discover available datasets.

§Arguments
  • limit - Maximum number of datasets to return (0 = all)
  • offset - Number of datasets to skip

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, 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<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