Skip to content

AsComponents::serialize is now AsComponents::as_batches and returns Collection<ComponentBatch> #8884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Jan 31, 2025

What

See title. This is a breaking change for custom AsComponents implementations. But we had plenty of breaking changes in that area, so now it's the right time.

The rename serialize to as_batches is motivated by the fact that previously we typically did to-arrow serializations in AsComponents. This is no longer the case and it's more of a collecting operation, just as we do in Rust's AsComponents::as_serialized_batches - since C++ only has ComponentBatch and no SerializedComponentBatch it follows that the method is just called as_batches now.

The change in return type fixes an old todo (no ticket) for using rerun::Collection for more flexibility in this area (pending improvements to rerun::Collection) and making our API handling more consistent in that regard.

Copy link

github-actions bot commented Jan 31, 2025

Latest documentation preview deployed successfully.

Result Commit Link
d58128e https://landing-b1e4oxcrp-rerun.vercel.app/docs

Note: This comment is updated whenever you push a commit.

Copy link

github-actions bot commented Jan 31, 2025

Web viewer built successfully. If applicable, you should also test it:

  • I have tested the web viewer
Result Commit Link Manifest
d58128e https://rerun.io/viewer/pr/8884 +nightly +main

Note: This comment is updated whenever you push a commit.

@teh-cmc teh-cmc self-requested a review January 31, 2025 17:07
@Wumpf Wumpf merged commit 80acaa7 into main Jan 31, 2025
36 checks passed
@Wumpf Wumpf deleted the andreas/cpp/better-ascomponents branch January 31, 2025 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants