Refactor Reader.Read API #49
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
tigrannajaryan
force-pushed
the
tigran/statereset
branch
from
dc8b506 to
890fe56
Compare
tigrannajaryan
force-pushed
the
tigran/readerapi
branch
from
3000e11 to
5452741
Compare
dmitryax
approved these changes
Feb 27, 2025
The API was inconsistent with Writer.Write() and was error-prone. The new API is consistent with Writer.Write(). Both Writer.Write() and Reader.Read() now work with a Record that is an exporter field in the Writer/Reader struct. This makes it obvious that the Record is owned by the struct. Previously it was not clear if the pointer to the record returned by Reader.Read() was owned by the caller and could be modified and what it's lifetime was. Now it is more intuitively clear that the caller does not own the record and should not touch it and that the next Read() operation is going to overwrite it. Also added pkg.ReadOptions to support reading options. The struct does not have any options yet, but options are coming in a future PR.
tigrannajaryan
force-pushed
the
tigran/readerapi
branch
from
5452741 to
d96e587
Compare
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.
The API was inconsistent with Writer.Write() and was error-prone.
The new API is consistent with Writer.Write(). Both Writer.Write() and Reader.Read() now work with a Record that is an exporter field in the Writer/Reader struct. This makes it obvious that the Record is owned by the struct. Previously it was not clear if the pointer to the record returned by Reader.Read() was owned by the caller and could be modified and what it's lifetime was. Now it is more intuitively clear that the caller does not own the record and should not touch it and that the next Read() operation is going to overwrite it.
Also added pkg.ReadOptions to support reading options. The struct does not have any options yet, but options are coming in a future PR.
This is stacked on top of #48