Version: v0.2.0

Rust API index

Every stable name Rust exports, and its extension seams.

Package: earthsciio 0.2.0

Documentation extracted with rustdoc JSON (rustdoc 1.101.0-nightly (21b707e3f 2026-09-30)), format_version 61.

Extension-tier names are on the Rust extension page .

Stable names

RustCanonicalKindSummary
CachecachetypeThe cache fetcher.
cache_keycache_keyfunctionCompute the cache key for a resolved URL: sha256(utf8(url)), lowercase hex.
CachedBlobcache_entrytypeA resolved cache entry: the blob path plus its manifest.
CommitReceiptcommit_receipttypeWhat a successful commit did.
CommitTokencommit_tokentypeThe value a writer hands the owner after flush (spec/writer.md §5.2).
data_dirdata_dirfunctionResolve the cache root $EARTHSCIDATADIR.
DataSourcedata_sourcetypeThe minimal parsed DataSource the Provider needs: where the bytes are, how to decode them, which variables to read, and the temporal cadence (absent ⇒ CONST).
DimWindowdim_windowtypeA named-dimension window, built one dimension at a time — the Rust spelling of spec/prefetch.md §2.2’s DimWindow (the run window (start, end) already owns the name Window).
EpochSampleepoch_sampletypeWhat PrefetchGroup::take returns: one Sample per member key.
ErrorerrorerrorErrors raised by the cache, transports, and stores.
Ff10Readerff10_readertypeThe active ff10 reader.
file_source_is_currentfile_source_is_currentfunctionRung 0 as a yes/no: is the source provably the file that was ingested?
file_source_statefile_source_statefunctionRung 0 without a memo: is the file:// source behind a cached entry still the file that was ingested into it?
GeoTiffReadergeotiff_readertypeThe active geotiff reader: pure-Rust raster decode + tiepoint georef.
is_offlineis_offlinefunctionResolve the effective offline flag: the explicit argument wins; otherwise fall back to EARTHSCI_OFFLINE.
ManifestmanifesttypeValidation + provenance record stored alongside every cached blob.
NativeDatasetnative_datasettypeA decoded native dataset: data variables keyed by on-disk name, plus the native coordinates of the loader’s grid.
NativeFieldnative_fieldtypeOne native-grid array, keyed by its on-disk file_variable name and validated against spec/schemas/native-field.schema.json.
NetcdfReadernetcdf_readertypeThe active netcdf reader: pure-Rust NetCDF-3 + NetCDF-4/HDF5 decode.
Orderprefetch_ordertypeThe order in which epochs will be taken (spec/prefetch.md §3.3).
ParquetReaderparquet_readertypeThe active parquet reader: an Apache Parquet file as a flat table on index.
PrefetchGroupprefetch_grouptypeBackground decode of upcoming epochs across several providers, bitwise identical to synchronous Provider::refresh.
ProviderprovidertypeA loader-bound provider of native-grid arrays, refreshed at the loader’s cadence.
read_blobread_blobfunctionRead a committed blob.
read_output_manifestread_output_manifestfunctionRead and parse output_manifest.json (v1 or v2).
read_recordread_recordfunctionRead the region of committed record index of variable var (shape: the variable’s dims minus time, region-sized).
read_staticread_staticfunctionRead the region of committed static name.
RegionregiontypeA block of the non-time dims, dim → start..stop (0-based, half-open).
Rolewriter_roletypeA writer’s role in a store (spec/writer.md §5).
Sampleprefetch_sampletypeOne member’s part of an epoch (spec/prefetch.md §3.4).
schema_fingerprintschema_fingerprintfunctionThe schema fingerprint (spec/writer.md §3.1): "sha256:" + hex over the canonical JSON of the schema’s structural fields.
sha256_filesha256_filefunctionStream a file through sha256 without loading it fully into memory.
ShapefileReadershapefile_readertypeThe shapefile format reader.
SourceTemporalsource_temporaltypeThe temporal nature of a loader that refreshes at a cadence (plan §4.2).
StreamSchemastream_schematypeThe stream schema: the v1 OutputSchema without data, plus a time mode, statics and per-variable dtypes.
TemporaltemporaltypeA loader’s temporal nature, supplying the TTL rung of the ladder.
TimeModeindexed_timetypeHow the record axis is addressed (spec/writer.md §6).
WindowwindowtypeA run window (start, end) — half-open [start, end).
ZarrReaderzarr_readertypeThe store-backed zarr reader (Zarr v3 + v2 chunked arrays, via zarrs).
ZarrStreamWriterstream_writertypeThe streaming writer handle (spec/writer.md).