Skip to content

feat(file): make Footer::new public#8602

Merged
robert3005 merged 1 commit into
vortex-data:developfrom
tobias-fire:th/public-file-footer-new
Jun 26, 2026
Merged

feat(file): make Footer::new public#8602
robert3005 merged 1 commit into
vortex-data:developfrom
tobias-fire:th/public-file-footer-new

Conversation

@tobias-fire

@tobias-fire tobias-fire commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Rationale for this change

vortex-file already exposes everything needed to write a Vortex file without the bundled VortexWriteOptions::write driver — the SegmentSink trait, accumulate_stats, FileStatistics, FooterSerializer, etc. are all public — except the final step of constructing the Footer. Footer::new is pub(crate), so downstream code that drives the layout/segment-write pipeline directly (e.g. a custom LayoutStrategy paired with a custom SegmentSink) has to either fork the crate or re-implement the writer inside it just to assemble the footer. This closes that single gap.

What changes are included in this PR?

  • Change Footer::new from pub(crate) to pub.

No behavioral change and no new dependencies. cargo check and cargo fmt --check pass locally.

What APIs are changed? Are there any user-facing changes?

One additive, non-breaking change: vortex_file::Footer::new is now public. Nothing else changes.


AI assistance disclosure: prepared with an agentic AI coding assistant (Claude Code), per the project's AI policy. The author reviewed the change and verification steps.

Everything needed to write a Vortex file without the bundled
`VortexWriteOptions::write` driver is already public — the `SegmentSink`
trait, `accumulate_stats`, `FileStatistics`, `FooterSerializer`, etc. —
except constructing the `Footer` itself. Expose `Footer::new` so code
that drives the layout/segment-write pipeline directly (e.g. a custom
`LayoutStrategy` with its own `SegmentSink`) can build a file entirely
on the public API instead of forking the crate.

Signed-off-by: Tobias Humig <tobias@firebolt.io>
@tobias-fire tobias-fire marked this pull request as ready for review June 26, 2026 11:38
@tobias-fire tobias-fire requested a review from a team June 26, 2026 11:38
@AdamGS AdamGS added the changelog/feature A new feature label Jun 26, 2026
@codspeed-hq

codspeed-hq Bot commented Jun 26, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 12.06%

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 2 improved benchmarks
✅ 1587 untouched benchmarks
⏩ 4 skipped benchmarks1

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation bitwise_not_vortex_buffer_mut[128] 244.4 ns 215.3 ns +13.55%
Simulation bitwise_not_vortex_buffer_mut[1024] 304.7 ns 275.6 ns +10.58%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.


Comparing tobias-fire:th/public-file-footer-new (febc53b) with develop (9567467)

Open in CodSpeed

Footnotes

  1. 4 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@robert3005 robert3005 merged commit f172d58 into vortex-data:develop Jun 26, 2026
79 of 81 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/feature A new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants