nahpu_dwc

A utility crate for mapping and converting Nahpu project data into the Darwin Core (DwC) JSON format. It automatically pulls the Nahpu drift database schema and maps its struct fields natively into the dwc and dcterms namespaces.

Example Usage

use nahpu_dwc::export::json::convert_to_dwc_json;
use serde::Serialize;

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct DummySite {
    site_id: String,
    country: String,
}

fn main() {
    let site = DummySite {
        site_id: "S1".to_string(),
        country: "USA".to_string(),
    };

    // Convert the struct to a Darwin Core mapped JSON
    let result = convert_to_dwc_json("site", &site).unwrap();
    
    // Output: {"dwc:locationID": "S1", "dwc:country": "USA"}
    println!("{}", result);
}

Darwin Core Data Package (DwC-DP) Export

You can seamlessly export entire collections of structs into a standard Darwin Core Data Package (which conforms to the Frictionless Data Package specification) by using DataPackageBuilder.

use nahpu_dwc::export::dp::DataPackageBuilder;
use serde::Serialize;
use std::path::Path;

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct DummySite {
    site_id: String,
    country: String,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let sites = vec![
        DummySite { site_id: "S1".to_string(), country: "USA".to_string() },
        DummySite { site_id: "S2".to_string(), country: "Canada".to_string() },
    ];

    let output_dir = Path::new("./export_output");
    std::fs::create_dir_all(&output_dir)?;

    let mut builder = DataPackageBuilder::new("nahpu_dp");
    
    // Serializes the structs into `site.csv` and auto-generates DwC headers
    builder.add_resource("site", &sites, &output_dir)?;
    
    // Emits the frictioneless `datapackage.json` connecting the resources
    builder.build(&output_dir)?;
    
    Ok(())
}

Simple Darwin Core XML Export

To natively export an array of structs into the flat XML format compliant with the Simple Darwin Core specification, you can use export_to_dwc_xml:

use nahpu_dwc::export::xml::export_to_dwc_xml;
use serde::Serialize;

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct DummySite {
    site_id: String,
    country: String,
}

fn main() {
    let sites = vec![
        DummySite { site_id: "S1".to_string(), country: "USA".to_string() }
    ];

    let xml = export_to_dwc_xml("site", &sites).unwrap();
    println!("{}", xml);
}

Nahpu to Darwin Core Mappings

The following table summarizes how Nahpu database fields map to official Darwin Core terms.