hfx-core

Shared types and validation primitives for HFX artifacts.

Purpose

hfx-core defines the canonical in-memory representation of the HFX specification. Every type enforces its invariants at construction time (parse, don't validate): an AtomId is always positive, a BoundingBox is always non-degenerate, a Manifest always names a real fabric. Invalid states are unrepresentable.

The crate has no I/O dependencies. Deserialization from Parquet, Arrow, JSON, and GeoTIFF is the responsibility of downstream crates (hfx-validator, source adapters, the delineation engine).

Architecture

graph TD
    subgraph Primitives
        id["id.rs\nAtomId, SnapId\nIdError"]
        area["area.rs\nAreaKm2, Weight\nMeasureError"]
        geo["geo.rs\nLongitude, Latitude\nBoundingBox, WkbGeometry\nGeoError"]
        raster["raster.rs\nFlowDirEncoding\nFlowDirEncodingError"]
    end

    subgraph Composites
        catchment["catchment.rs\nCatchmentAtom"]
        snap["snap.rs\nSnapTarget, MainstemStatus"]
        graph["graph.rs\nAdjacencyRow, DrainageGraph\nGraphError"]
        manifest["manifest.rs\nManifest, ManifestBuilder\nCrs, Topology, FormatVersion\nUpAreaAvailability, RasterAvailability\nSnapAvailability, AtomCount\nManifestError"]
    end

    subgraph "lib.rs (root)"
        lib["HasBbox trait\nHasAtomId trait\nre-exports"]
    end

    catchment --> id & area & geo
    snap --> id & area & geo
    graph --> id
    manifest --> geo & raster
    lib --> catchment & snap & graph & manifest

Glossary

Key Types