Struct DataGovClient 

pub struct DataGovClient { /* private fields */ }

High-level client for interacting with data.gov

This client wraps the CKAN client and provides additional functionality for downloading resources, managing files, and working with data.gov specifically.

Implementations

impl DataGovClient

pub fn new() -> Result<Self>

Create a new DataGov client with default configuration

Examples found in repository

examples/demo.rs (line 10)

async fn main() -> Result<(), Box<dyn Error>> {
    println!("🇺🇸 Data.gov Rust Client Demo");
    println!("================================\n");

    // Create a client
    let client = DataGovClient::new()?;

    // 1. Search for datasets
    println!("🔍 Searching for 'climate' datasets...");
    let search_results = client.search("climate", Some(5), None, None, None).await?;

    println!("Found {} results:\n", search_results.count.unwrap_or(0));

    if let Some(results) = &search_results.results {
        for (i, dataset) in results.iter().enumerate() {
            println!(
                "{}. {} ({})",
                i + 1,
                dataset.title.as_deref().unwrap_or(&dataset.name),
                dataset.name
            );

            // Show resource count
            let resources = DataGovClient::get_downloadable_resources(dataset);
            println!("   📁 {} downloadable resources", resources.len());

            if let Some(notes) = &dataset.notes {
                let truncated = if notes.len() > 100 {
                    format!("{}...", &notes[..100])
                } else {
                    notes.clone()
                };
                println!("   📄 {}", truncated);
            }
            println!();
        }
    }

    // 2. Get organizations
    println!("🏛️  Listing government organizations...");
    let orgs = client.list_organizations(Some(10)).await?;
    println!("Found {} organizations:", orgs.len());
    for (i, org) in orgs.iter().enumerate().take(5) {
        println!("  {}. {}", i + 1, org);
    }
    println!();

    // 3. Autocomplete example
    println!("🔍 Autocomplete for 'energy'...");
    let suggestions = client.autocomplete_datasets("energy", Some(5)).await?;
    println!("Suggestions:");
    for suggestion in suggestions {
        println!("  • {}", suggestion);
    }
    println!();

    println!("✅ Demo completed! Try the interactive REPL with:");
    println!("   data-gov");
    println!();
    println!("Example CLI commands:");
    println!("  data-gov search \"climate data\"");
    println!("  data-gov show consumer-complaint-database");
    println!("  data-gov download consumer-complaint-database 0");
    println!("  data-gov list organizations");
    println!("  data-gov --help");

    Ok(())
}

pub fn with_config(config: DataGovConfig) -> Result<Self>

Create a new DataGov client with custom configuration

pub async fn search( &self, query: &str, limit: Option<i32>, offset: Option<i32>, organization: Option<&str>, format: Option<&str>, ) -> Result<PackageSearchResult>

Search for datasets on data.gov

Arguments

• query - Search terms (searches titles, descriptions, tags)
• limit - Maximum number of results (default: 10, max: 1000)
• offset - Number of results to skip for pagination (default: 0)
• organization - Filter by organization name (optional)
• format - Filter by resource format (optional, e.g., “CSV”, “JSON”)

Examples

Basic search:

let client = DataGovClient::new()?;
let results = client.search("climate data", Some(20), None, None, None).await?;

Search with filters:

let results = client.search("energy", Some(10), None, Some("doe-gov"), Some("CSV")).await?;

Examples found in repository

examples/demo.rs (line 14)

async fn main() -> Result<(), Box<dyn Error>> {
    println!("🇺🇸 Data.gov Rust Client Demo");
    println!("================================\n");

    // Create a client
    let client = DataGovClient::new()?;

    // 1. Search for datasets
    println!("🔍 Searching for 'climate' datasets...");
    let search_results = client.search("climate", Some(5), None, None, None).await?;

    println!("Found {} results:\n", search_results.count.unwrap_or(0));

    if let Some(results) = &search_results.results {
        for (i, dataset) in results.iter().enumerate() {
            println!(
                "{}. {} ({})",
                i + 1,
                dataset.title.as_deref().unwrap_or(&dataset.name),
                dataset.name
            );

            // Show resource count
            let resources = DataGovClient::get_downloadable_resources(dataset);
            println!("   📁 {} downloadable resources", resources.len());

            if let Some(notes) = &dataset.notes {
                let truncated = if notes.len() > 100 {
                    format!("{}...", &notes[..100])
                } else {
                    notes.clone()
                };
                println!("   📄 {}", truncated);
            }
            println!();
        }
    }

    // 2. Get organizations
    println!("🏛️  Listing government organizations...");
    let orgs = client.list_organizations(Some(10)).await?;
    println!("Found {} organizations:", orgs.len());
    for (i, org) in orgs.iter().enumerate().take(5) {
        println!("  {}. {}", i + 1, org);
    }
    println!();

    // 3. Autocomplete example
    println!("🔍 Autocomplete for 'energy'...");
    let suggestions = client.autocomplete_datasets("energy", Some(5)).await?;
    println!("Suggestions:");
    for suggestion in suggestions {
        println!("  • {}", suggestion);
    }
    println!();

    println!("✅ Demo completed! Try the interactive REPL with:");
    println!("   data-gov");
    println!();
    println!("Example CLI commands:");
    println!("  data-gov search \"climate data\"");
    println!("  data-gov show consumer-complaint-database");
    println!("  data-gov download consumer-complaint-database 0");
    println!("  data-gov list organizations");
    println!("  data-gov --help");

    Ok(())
}

pub async fn get_dataset(&self, dataset_id: &str) -> Result<Package>

Get detailed information about a dataset

pub async fn autocomplete_datasets( &self, partial: &str, limit: Option<i32>, ) -> Result<Vec<String>>

Get autocomplete suggestions for dataset names

Examples found in repository

examples/demo.rs (line 54)

async fn main() -> Result<(), Box<dyn Error>> {
    println!("🇺🇸 Data.gov Rust Client Demo");
    println!("================================\n");

    // Create a client
    let client = DataGovClient::new()?;

    // 1. Search for datasets
    println!("🔍 Searching for 'climate' datasets...");
    let search_results = client.search("climate", Some(5), None, None, None).await?;

    println!("Found {} results:\n", search_results.count.unwrap_or(0));

    if let Some(results) = &search_results.results {
        for (i, dataset) in results.iter().enumerate() {
            println!(
                "{}. {} ({})",
                i + 1,
                dataset.title.as_deref().unwrap_or(&dataset.name),
                dataset.name
            );

            // Show resource count
            let resources = DataGovClient::get_downloadable_resources(dataset);
            println!("   📁 {} downloadable resources", resources.len());

            if let Some(notes) = &dataset.notes {
                let truncated = if notes.len() > 100 {
                    format!("{}...", &notes[..100])
                } else {
                    notes.clone()
                };
                println!("   📄 {}", truncated);
            }
            println!();
        }
    }

    // 2. Get organizations
    println!("🏛️  Listing government organizations...");
    let orgs = client.list_organizations(Some(10)).await?;
    println!("Found {} organizations:", orgs.len());
    for (i, org) in orgs.iter().enumerate().take(5) {
        println!("  {}. {}", i + 1, org);
    }
    println!();

    // 3. Autocomplete example
    println!("🔍 Autocomplete for 'energy'...");
    let suggestions = client.autocomplete_datasets("energy", Some(5)).await?;
    println!("Suggestions:");
    for suggestion in suggestions {
        println!("  • {}", suggestion);
    }
    println!();

    println!("✅ Demo completed! Try the interactive REPL with:");
    println!("   data-gov");
    println!();
    println!("Example CLI commands:");
    println!("  data-gov search \"climate data\"");
    println!("  data-gov show consumer-complaint-database");
    println!("  data-gov download consumer-complaint-database 0");
    println!("  data-gov list organizations");
    println!("  data-gov --help");

    Ok(())
}

pub async fn list_organizations( &self, limit: Option<i32>, ) -> Result<Vec<String>>

Get list of organizations (government agencies)

Examples found in repository

examples/demo.rs (line 45)

async fn main() -> Result<(), Box<dyn Error>> {
    println!("🇺🇸 Data.gov Rust Client Demo");
    println!("================================\n");

    // Create a client
    let client = DataGovClient::new()?;

    // 1. Search for datasets
    println!("🔍 Searching for 'climate' datasets...");
    let search_results = client.search("climate", Some(5), None, None, None).await?;

    println!("Found {} results:\n", search_results.count.unwrap_or(0));

    if let Some(results) = &search_results.results {
        for (i, dataset) in results.iter().enumerate() {
            println!(
                "{}. {} ({})",
                i + 1,
                dataset.title.as_deref().unwrap_or(&dataset.name),
                dataset.name
            );

            // Show resource count
            let resources = DataGovClient::get_downloadable_resources(dataset);
            println!("   📁 {} downloadable resources", resources.len());

            if let Some(notes) = &dataset.notes {
                let truncated = if notes.len() > 100 {
                    format!("{}...", &notes[..100])
                } else {
                    notes.clone()
                };
                println!("   📄 {}", truncated);
            }
            println!();
        }
    }

    // 2. Get organizations
    println!("🏛️  Listing government organizations...");
    let orgs = client.list_organizations(Some(10)).await?;
    println!("Found {} organizations:", orgs.len());
    for (i, org) in orgs.iter().enumerate().take(5) {
        println!("  {}. {}", i + 1, org);
    }
    println!();

    // 3. Autocomplete example
    println!("🔍 Autocomplete for 'energy'...");
    let suggestions = client.autocomplete_datasets("energy", Some(5)).await?;
    println!("Suggestions:");
    for suggestion in suggestions {
        println!("  • {}", suggestion);
    }
    println!();

    println!("✅ Demo completed! Try the interactive REPL with:");
    println!("   data-gov");
    println!();
    println!("Example CLI commands:");
    println!("  data-gov search \"climate data\"");
    println!("  data-gov show consumer-complaint-database");
    println!("  data-gov download consumer-complaint-database 0");
    println!("  data-gov list organizations");
    println!("  data-gov --help");

    Ok(())
}

pub async fn autocomplete_organizations( &self, partial: &str, limit: Option<i32>, ) -> Result<Vec<String>>

Get autocomplete suggestions for organizations

pub fn get_downloadable_resources(package: &Package) -> Vec<Resource>

Find downloadable resources in a dataset

Returns a list of resources that have URLs and are likely downloadable files

Examples found in repository

examples/demo.rs (line 28)

async fn main() -> Result<(), Box<dyn Error>> {
    println!("🇺🇸 Data.gov Rust Client Demo");
    println!("================================\n");

    // Create a client
    let client = DataGovClient::new()?;

    // 1. Search for datasets
    println!("🔍 Searching for 'climate' datasets...");
    let search_results = client.search("climate", Some(5), None, None, None).await?;

    println!("Found {} results:\n", search_results.count.unwrap_or(0));

    if let Some(results) = &search_results.results {
        for (i, dataset) in results.iter().enumerate() {
            println!(
                "{}. {} ({})",
                i + 1,
                dataset.title.as_deref().unwrap_or(&dataset.name),
                dataset.name
            );

            // Show resource count
            let resources = DataGovClient::get_downloadable_resources(dataset);
            println!("   📁 {} downloadable resources", resources.len());

            if let Some(notes) = &dataset.notes {
                let truncated = if notes.len() > 100 {
                    format!("{}...", &notes[..100])
                } else {
                    notes.clone()
                };
                println!("   📄 {}", truncated);
            }
            println!();
        }
    }

    // 2. Get organizations
    println!("🏛️  Listing government organizations...");
    let orgs = client.list_organizations(Some(10)).await?;
    println!("Found {} organizations:", orgs.len());
    for (i, org) in orgs.iter().enumerate().take(5) {
        println!("  {}. {}", i + 1, org);
    }
    println!();

    // 3. Autocomplete example
    println!("🔍 Autocomplete for 'energy'...");
    let suggestions = client.autocomplete_datasets("energy", Some(5)).await?;
    println!("Suggestions:");
    for suggestion in suggestions {
        println!("  • {}", suggestion);
    }
    println!();

    println!("✅ Demo completed! Try the interactive REPL with:");
    println!("   data-gov");
    println!();
    println!("Example CLI commands:");
    println!("  data-gov search \"climate data\"");
    println!("  data-gov show consumer-complaint-database");
    println!("  data-gov download consumer-complaint-database 0");
    println!("  data-gov list organizations");
    println!("  data-gov --help");

    Ok(())
}

pub fn get_resource_filename( resource: &Resource, fallback_name: Option<&str>, ) -> String

Get the best download filename for a resource

pub async fn download_dataset_resource( &self, resource: &Resource, dataset_name: &str, ) -> Result<PathBuf>

Download a resource from a dataset to its dataset-specific directory

Arguments

• resource - The resource to download
• dataset_name - Name of the dataset (used for subdirectory)

Returns the path where the file was saved

pub async fn download_resource( &self, resource: &Resource, output_path: Option<PathBuf>, ) -> Result<PathBuf>

Download a resource to a file

Arguments

• resource - The resource to download
• output_path - Where to save the file (if None, uses base download directory)

Returns the path where the file was saved

pub async fn download_resources( &self, resources: &[Resource], output_dir: Option<&Path>, ) -> Vec<Result<PathBuf>>

Download multiple resources concurrently

Returns a vector of results, each containing either the download path or an error

pub async fn download_dataset_resources( &self, resources: &[Resource], dataset_name: &str, ) -> Vec<Result<PathBuf>>

Download multiple resources from a dataset to its dataset-specific directory

Returns a vector of results, each containing either the download path or an error

pub async fn validate_download_dir(&self) -> Result<()>

Check if the base download directory exists and is writable

pub fn download_dir(&self) -> PathBuf

Get the current base download directory

pub fn ckan_client(&self) -> &CkanClient

Get the underlying CKAN client for advanced operations

Trait Implementations

impl Debug for DataGovClient

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

Formats the value using the given formatter.

impl Default for DataGovClient

fn default() -> Self

Returns the “default value” for a type.