stt-core 0.1.0

Core library for spatiotemporal tile format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Core library for the **SpatioTemporal Tiles (STT)** format.
//!
//! The canonical container is the **packed format** ([`pack`]): a per-dataset
//! `manifest.json` plus many content-addressed, immutable pack objects
//! (`packs/<blake3>.sttp`) and one directory object (`index/<blake3>.sttd`).
//! Splitting a dataset into small, immutable objects is what makes it
//! edge-cacheable on a plain CDN — see `docs/spec/stt-packed-format.md`.
//!
//! Building blocks:
//! - [`pack`] — the packed format: [`PackWriter`], [`PackedReader`], [`Manifest`],
//!   [`transcode_archive_to_packs`], [`verify_packed_objects`].
//! - [`arrow_tile`] — Arrow-IPC tile payloads with GeoArrow geometry.
//! - [`directory`] — the run-length tile directory (v5 = packed; v4 = legacy single-file).
//! - [`curve`] — spatial (Hilbert) + temporal blob ordering.
//! - [`metadata`] — dataset metadata (folded verbatim into the manifest).
//! - [`compression`] — per-blob zstd / gzip.
//!
//! The single-file [`archive`] container ([`ArchiveWriter`] / [`ArchiveReader`])
//! predates the packed format and is **no longer a deployment target**. It
//! survives only as (a) the bounded-RAM streaming *intermediate* that
//! `stt-build --streaming-arrow` transcodes into packs, and (b) the read side
//! that [`transcode_archive_to_packs`] consumes when migrating old archives.

pub mod archive;
pub mod arrow_tile;
pub mod budget;
pub mod compression;
pub mod curve;
pub mod directory;
pub mod directory_page;
pub mod error;
pub mod geometry;
pub mod metadata;
pub mod pack;
pub mod projection;
pub mod tile;
pub mod timestamp;
pub mod types;

// Re-export commonly used types.
// Packed format — the canonical container.
pub use pack::{
    repack_directory, transcode_archive_to_packs, transcode_archive_to_packs_paged,
    transcode_archive_to_packs_paged_level, transcode_packs_to_packs_paged_level,
    verify_packed_objects, Manifest, PackWriter, PackedReader,
};
pub use directory_page::{
    decode_paged_directory, encode_paged_directory, verify_paged_structure, PageDescriptor,
    PagedRoot, DEFAULT_PAGE_ENTRIES,
};
// Single-file archive — legacy/intermediate surface (see the module doc above).
pub use archive::{Archive, ArchiveReader, ArchiveWriter};
pub use curve::BlobOrdering;
pub use error::{Error, Result};
pub use tile::TileId;
pub use timestamp::{
    normalize_timestamp_to_ms, reject_negative_timestamp, scale_timestamp_to_ms, TimestampUnit,
};
pub use types::{BoundingBox, TimeRange};

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_tile_id_ordering() {
        let t1 = TileId::new(10, 512, 384, 1609459200000);
        let t2 = TileId::new(10, 512, 384, 1609545600000);
        assert!(t1 < t2);
    }
}