refactor: rename FileStream.file_reader to file_opener & update doc #8883
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
9 tasks
alamb
approved these changes
Jan 16, 2024
There was a problem hiding this comment.
Thank you for the contribution @SteveLauC - looks like a nice improvement to me.
| @@ -269,7 +267,7 @@ impl<F: FileOpener> FileStream<F> { | |||
| file_iter: files.into(), | |||
| projected_schema, | |||
| remain: config.limit, | |||
| file_reader, | |||
| file_opener: file_reader, | |||
There was a problem hiding this comment.
Perhaps you can change the name of the parameter to this function to file_opener to match the field name too?
There was a problem hiding this comment.
Sorry I missed this one:D
| /// is not capable of limiting the number of records in the last batch, the file | ||
| /// stream will take care of truncating it. | ||
| file_reader: F, | ||
| /// A generic file opener, calling `open()` on it will return a `FileOpenFuture`, |
There was a problem hiding this comment.
Suggested change
| /// A generic file opener, calling `open()` on it will return a `FileOpenFuture`, | |
| /// A generic [`FileOpener`]/ Calling `open()` returns a [`FileOpenFuture`], |
There was a problem hiding this comment.
Done
Though I changed that / to a .
SteveLauC
force-pushed
the
file_opener
branch
from
369b7a1
to
4e7e0e8
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.
Which issue does this PR close?
Can be seen as a fix to #2990.
Rationale for this change
The
FileStream.file_readerfield is a generic type that implements theFileOpenertrait, so it is kinda confusing to call itfile_readerrather thanfile_opener.#2291 tried to do some naming refactoring to this file, but it seems that @tustvold forgot to update this field name I guess?
And that doc comment was added in #1138, which is quite old and outdated.
What changes are included in this PR?
FileStream.file_readertoFileStream.file_opener.Are these changes tested?
No
Are there any user-facing changes?
This field is private so I guess no.