Skip to main content

PackWriter

Struct PackWriter 

Source
pub struct PackWriter { /* private fields */ }
Expand description

Writer for the multi-object packed format.

Consumes an (id, payload) stream like crate::archive::ArchiveWriter, buffering every tile until finalize. At finalize it reuses the buffered-writer pipeline — resolve BlobOrdering::Auto, sort by the space-time curve key, per-blob zstd (NO shared dictionary, so the fzstd TS reader can decode), byte-identical dedup via blake3 — then cuts the ordered/deduped blob stream into packs of ≤ pack_target_bytes, never splitting a blob, and writes content-addressed packs/*.sttp + index/*.sttd + manifest.json.

Implementations§

Source§

impl PackWriter

Source

pub fn create<P: AsRef<Path>>( out_dir: P, ordering: BlobOrdering, pack_target_bytes: u64, ) -> Result<Self>

Create a packed-format writer targeting out_dir.

out_dir (and its index/ + packs/ subdirs) are created on finalize. ordering controls the on-disk blob byte order (BlobOrdering::Auto resolves per-dataset at finalize); pack_target_bytes is the soft per-pack size cap — a single blob larger than the target gets its own pack rather than being split.

Source

pub fn with_paging(self, page_entries: Option<usize>) -> Self

Opt into a paged directory: the .sttd becomes a root page + leaf pages of ≤ page_entries entries each, so a cold reader fetches only the leaves its viewport/time-window touches (Wave 2). None (the default) emits the single whole-load v5 directory — byte-identical output to a pre-paging build. Some(0) is clamped to 1.

Source

pub fn with_zstd_level(self, level: i32) -> Self

Set the zstd compression level for tile blobs and the directory.

The packed format is write-once / serve-many, so the higher build CPU of a level like 19 is paid once while the smaller bytes are paid on every fetch (measured −10..19% vs the level-3 default; decode is unaffected). Clamped to zstd’s valid 1..=22 range. The default (compression::ZSTD_LEVEL) reproduces byte-identical pre-existing builds.

Source

pub fn add_tile_full( &mut self, id: &TileId, time_start: i64, time_end: i64, cover_t_min: Option<i64>, feature_count: u32, temporal_bucket_ms: Option<u64>, payload: &[u8], ) -> Result<()>

Add a tile carrying the full directory metadata. Same shape as crate::archive::ArchiveWriter::add_tile_full: cover_t_min is the tight lower covering bound (None to omit), temporal_bucket_ms tags the directory entry with the temporal bucket size the tile represents. The payload is the uncompressed tile frame.

Source

pub fn tile_count(&self) -> usize

Number of tiles buffered so far.

Source

pub fn finalize(self, metadata: &Metadata) -> Result<Manifest>

Finalise: order + dedup + per-blob zstd, cut packs, write packs/*.sttp + index/*.sttd + manifest.json into out_dir.

Mirrors ArchiveWriter::finalize_buffered: the same time-bucket calc, BlobOrdering::AutoBlobOrdering::choose resolution, space-time sort key, per-blob compress_zstd_with_dict(_, None) (no shared dict), and blake3 byte-identical dedup. THEN the ordered, deduped blob stream is cut into packs.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool