Crate spatialrust_records 

Versioned spatial records, schema evolution, and chunked host streams.

This crate stays Arrow-free. Arrow C Data/Stream/Device live in spatialrust-arrow behind independent features.

Structs

CancellationToken

Cloneable cooperative cancellation state checked at chunk boundaries.

ChunkIdentity

Stable location of one chunk in its source stream.

LegacyBoundedSink

Adapts an existing synchronous sink to leased record chunks.

LegacyBoundedSource

Adapts an existing record source without changing its public trait.

MemoryBudget

Hard limit for memory explicitly owned by a streaming execution.

MemoryChunkSink

Collects records into an owned point cloud.

MemoryChunkSource

Splits one in-memory cloud into fixed-size record chunks.

MemoryReservation

RAII token that releases an exact tracked byte count on drop.

MemorySnapshot

Point-in-time memory accounting values.

MemoryTracker

Concurrent, exact accounting for memory explicitly owned by a stream.

MigrationPolicy

Migration permissions when projecting a record onto a target schema.

PrefetchRecordSource

Single-worker deterministic prefetch with count and memory backpressure.

RecordBounds3

Finite axis-aligned bounds carried by a record chunk.

RecordProvenance

Generic source lineage for one crate::SpatialRecord.

RecyclingMemoryChunkSource

In-memory source used to verify real buffer recycling and lease accounting.

SchemaCompatReport

Detailed schema comparison report.

SchemaDescriptor

Named, versioned PointSchema contract.

SchemaId

Stable schema family identifier independent of field order serialization.

SchemaVersion

Semantic schema version used for evolution checks.

SpatialRecord

One versioned point-cloud observation with attached metadata.

SpatialRecordChunk

One owned record plus the memory lease that keeps it inside the hard limit.

StreamOptions

Common bounded-stream execution options.

StreamingPhaseReceipt

Timing and allocation counters for one named execution phase.

StreamingReceipt

Versioned, deterministic accounting receipt for one streaming execution.

StreamingTransferReceipt

One named, explicit transfer included in a streaming receipt.

StreamingWorkload

One canonical scale/chunk/budget combination for reproducible comparisons.

Enums

CompatVerdict

High-level comparison result between two schemas.

FieldFill

How to fill fields missing from the source cloud.

RecordsError

Shared record/stream failures.

StreamOrdering

Ordering guarantee requested from a streaming source or pipeline.

StreamingTransferDirection

Direction of an explicit host/device transfer.

Constants

DEFAULT_STREAM_CHUNK_POINTS

Default number of points requested from a streaming source.

DEFAULT_STREAM_MEMORY_BUDGET_BYTES

Default hard limit for explicitly tracked streaming memory (256 MiB).

RECORD_PROVENANCE_VERSION

Current version of the record-provenance contract.

STREAMING_RECEIPT_SCHEMA

Stable identifier for the versioned JSON receipt contract.

STREAMING_RECEIPT_VERSION

Current streaming receipt schema version.

Traits

BoundedSpatialRecordSink

Push-based bounded sink that cannot retain a record beyond the chunk lease.

BoundedSpatialRecordSource

Pull-based bounded source. Existing SpatialRecordSource remains unchanged.

SpatialRecordSink

Push-based sink for versioned spatial records.

SpatialRecordSource

Pull-based source of versioned spatial records.

Functions

canonical_streaming_workloads

Returns the canonical 1M/10M/100M streaming workload matrix.

compare_schemas

Compares actual against expected using id/version plus field contracts.

migrate_record

Projects record onto target under an explicit migration policy.

record_storage_bytes

Returns the allocated scalar capacity bytes owned by a record.

Type Aliases

RecordsResult

Result type for record and stream operations.