Implement RecordStream for iterating over scanned records#160
Open
snowsignal wants to merge 2 commits into
Open
Implement RecordStream for iterating over scanned records#160snowsignal wants to merge 2 commits into
RecordStream for iterating over scanned records#160snowsignal wants to merge 2 commits into
Conversation
…nous iteration over a `Recordset`
Collaborator
|
Thank you for your feedback and PR. I need some clarification though:
Is possible to provide a gist to help me understand and reproduce the issue on my side? Thank you. |
This file contains hidden or 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
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.
This PR solves two problems with
Recordset:Recordsetiterator callsstd::thread::yield_now()internally.Arc<Recordset>can be sent between threads, and iterated over in multiple places at once, which would leave each thread with a partial iteration over the scanned records. Ideally, it should be impossible to iterate over the scanned records in more than one thread at once.To solve these, I've implemented a new struct,
RecordStream, that acts as an iterable wrapper over anArc<Recordset>. It can be created by a newinto_stream()method onArc<Recordset>, and crucially, this will make at most oneRecordStreamavailable at any one time—trying to instantiate a secondRecordStreamwill returnNone.RecordStreamimplements both the synchronousIteratortrait that was previously implemented for&Recordset, but it also supports asynchronous iteration viafutures::Stream.It might be worth considering whether
Client::scanshould just return aRecordStreamdirectly, though this can be done in a follow-up PR.