use Into<String> as argument type wherever applicable #615
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
alamb
reviewed
Jun 24, 2021
alamb
approved these changes
Jun 24, 2021
| options: CsvReadOptions, | ||
| projection: Option<Vec<usize>>, | ||
| ) -> Result<Self> { | ||
| let provider = Arc::new(CsvFile::try_new(path, options)?); | ||
| let path = path.into(); |
There was a problem hiding this comment.
As above, this pattern just doesn't make a lot of sense to me -- if someone passed in a &str then this code will now create a copy (a String) and then simply use a reference to that copy (rather than the path itself)
There was a problem hiding this comment.
the owned value is passed along to Self::scan at the end of the function.
| provider: Arc<dyn TableProvider>, | ||
| projection: Option<Vec<usize>>, | ||
| ) -> Result<Self> { | ||
| let table_name = table_name.into(); |
There was a problem hiding this comment.
This change makes sense to me as this function previously was making an explicit copy and no can reuse the copy the caller passed in, if any 👍
table_name: table_name.to_string(),
| @@ -44,10 +44,10 @@ pub struct Column { | |||
|
|
|||
| impl Column { | |||
| /// Create Column from unqualified name. | |||
| pub fn from_name(name: String) -> Self { | |||
| pub fn from_name(name: impl Into<String>) -> Self { | |||
alamb
approved these changes
Jun 25, 2021
|
I think this one is ready - it just needs to be rebased |
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.
Rationale for this change
Following the article shared by @jorgecarleitao: https://phaazon.net/blog/on-owning-borrowing-pub-interface. Using
impl Into<T>as argument type makes it possible for function to take ownership of an argument while providing the flexibility to the callers to decide whether they want to pass argument by reference or by value.@Dandandan also proposed this pattern in #55 for the builder interface: https://github.com/apache/arrow-datafusion/blob/d55a10569b3a24195bed2d67cc6414c63b6b2336/datafusion/src/logical_plan/builder.rs#L264
I just never thought of extending it to other existing functions and types until I saw that article. I think we can apply this same pattern to other types as well like
LogicalPlanBuilder::from, which takes a reference of LogicalPlan as argument and clones it internally.What changes are included in this PR?
Change
&strtoimpl Into<String>for functions that does internal clone of the string.Are there any user-facing changes?
No breaking API change.