rust: rename items in linear reader #1341
Merged
Conversation
This file contains 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
Muon
reviewed
Feb 27, 2025
Muon
reviewed
Feb 27, 2025
gasmith
approved these changes
Feb 27, 2025
Muon
approved these changes
Mar 3, 2025
bennetthardwick
added a commit
that referenced
this pull request
Mar 26, 2025
### Changelog <!-- Write a one-sentence summary of the user-impacting change (API, UI/UX, performance, etc) that could appear in a changelog. Write "None" if there is no user-facing change --> Make `Writher::with_options` public ### Docs <!-- Link to a Docs PR, tracking ticket in Linear, OR write "None" if no documentation changes are needed. --> None ### Description Makes the `Writer::with_options` method in the Rust library public to easier support setting options. This also bumps the version to 0.16.0 in preparation to release this and the breaking changes from #1341. Fixes #1348.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changelog
mcap::sans_io::readtomcap::sans_io::linear_reader.mcap::sans_io::read::ReadActiontomcap::sans_io::linear_reader::LinearReadEventLinearReader::next_action()toLinearReader::next_event().LinearReader::set_written()toLinearReader::notify_read().mcap::tokio::read::RecordReadertomcap::tokio::linear_reader::LinearReaderDocs
Changes are reflected in
cargo doc.Description
This PR revises the names of functions and structs exposed from the
sans_iomodule, because they're badly named as-is and we need to fix this now before we add more to this module.Specifically:
ReadActiongets renamed toLinearReadEvent. This is because there's no definition of "action" in this context that makes sense - NeedMore is not an action. NeedMore is requesting the caller take some action, but then GetMessage is not requesting the caller to do anything. "events" are a term more commonly used in other parsers such as SAX, and can be interpreted more generally.set_written()is renamed tonotify_read(). This better reflects what it's for (notifying the reader of the result of a read), and I found the termwrittenconfusing on a struct meant to be used for reading.tokio::RecordReaderis renamed to LinearReader for consistency.sans_io::readmodule is renamed tolinear_reader- This better reflects its contents. When we add more readers to the sans_io module, I don't intend to add them all to thesans_io::readmodule, it doesn't help anyone to nest so deeply.