Skip to content
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

Draft: re-organize things in re_log_encoding #8797

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Conversation

zehiko
Copy link
Contributor

@zehiko zehiko commented Jan 24, 2025

This is a heavy draft (things compile, but tons of broken link complaints), I spent some times re-organizing things so that everything related to rrd encoding ends up in the relevant module. This than ensures we only need to make the public interface actually public through relevant module exports. There's no new code, no publicly exposed functions were renamed (to confine the changes as much as possible to just this package, but things were moved around heavily.

To make sense of things, perhaps worth looking into lib.rs and what gets exposed and how.

We can drop this on the floor if we think it's not worth doing or doesn't make sense. My motivation was to not publicly expose guts of rrd protocol just because of module organization, but maybe it only makes sense to me.

Brief summary of changes:

  • everything is moved under codec module. We already had file and wire there, but now we have rrd and wire
  • all shared errors are at the codec errors now, same as Compression, VersionPolicy, etc
  • anything related to rrd (encoders, decoders, public helper functions) is now in codec/rrd/encoder and codec/rrd/decoder and publicly exported to match the previous public export
  • there was some naming conflict, for example encode for the previously public function and encode that is internally used. private encode is now encode_msg

Copy link

github-actions bot commented Jan 24, 2025

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant