Release v0.2.3: spatial streaming I/O and Rust acceleration#46
Closed
thanos wants to merge 4 commits into
Closed
Conversation
…ntal I/O.
**Behavior**
`source: :file` (or `:auto` path detection): read 16-byte EXCP / 18-byte GSPL header, then one fixed-size record via `IO.binread/2`
Peak memory ≈ header + one record (file handle stays open for the stream lifetime)
In-memory binaries still materialize through `decode/2` (mmap left for a future Rust backend)
**Wiring**
`ExCodecs.Spatial.Stream` forwards `EXCP/GSPL` sources to the codecs — no more full File.read for those formats
Docs updated in `spatial.ex`, `docs/spatial_formats.md`, the spatial guide, and `CHANGELOG` Unreleased
**Usage**
```elixir
ExCodecs.Spatial.stream_decode(path, format: :spatial_binary, source: :file)
|> Stream.take(100)
|> Enum.to_list()
ExCodecs.Spatial.stream_decode(path, format: :gsplat, source: :file)
|> Enum.each(&process/1)
```
Truncation / missing files yield a single `{:error, %ExCodecs.Error{}}` element.
closed #38 - PLY stream_decode (source: :file) — scans until end_header, then yields one vertex at a time (binary: fixed stride via IO.binread; ASCII: line reads). Supports :as / Gaussian auto-detect.
closed #39 - stream_encode_to_file/3 — EXCP and GSPL write a placeholder header, stream records, seek back to patch count. Requires explicit :schema. Spatial.Stream.encode_to_file/3 uses this when schema: + format: :spatial_binary / :gsplat.
closed #40
…plus enumerable_points/1 / enumerable_gaussians/1. Credo is clean and the stream tests pass.
Version
mix.exs → 0.2.3
native/ex_codecs_native/Cargo.toml → 0.2.3
Changelog
Moved Unreleased items into [0.2.3] - 2026-07-18 (streaming I/O, schema encode-to-file, Rust accel, Mix cli/0)
Docs
README install pin, streaming limitations, native layer note
docs/spatial_formats.md, docs/architecture.md, guides/understanding_spatial_codecs.md
All livebooks → {:ex_codecs, "~> 0.2.3"}; spatial livebook streaming section updated
Fix NIF availability registration order, drop stale docs from the Hex package, correct streaming/work_factor/from_nif docs, repair livebook demos, and make Accel tests skip cleanly when the spatial NIF is absent. Co-authored-by: Cursor <cursoragent@cursor.com>
Owner
Author
|
Closed: opened without explicit permission; reverting related remote publish artifacts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
stream_decodefrom files (bounded memory), plus schema-drivenstream_encode_to_fileTest plan
mix test(accel + application tests verified locally)v0.2.3triggers Release workflow (NIF artifacts + Hex publish)0.2.3Made with Cursor