Skip to content

Remove &mut from io::read_to_string signature #92863

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jan 15, 2022

Conversation

camelid
Copy link
Member

@camelid camelid commented Jan 13, 2022

@m-ou-se realized that because Read is implemented for &mut impl Read, there's no need to take &mut in io::read_to_string.

Removing the &mut from the signature allows users to remove the &mut
from their calls (and thus pass an owned reader) if they don't use the
reader later.

r? @m-ou-se

@camelid camelid added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. A-io Area: `std::io`, `std::fs`, `std::net` and `std::path` labels Jan 13, 2022
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 13, 2022
@camelid
Copy link
Member Author

camelid commented Jan 13, 2022

I can't think of any downsides to this change, but of course let me know if you think of one :)

@camelid
Copy link
Member Author

camelid commented Jan 13, 2022

Should I add a test for passing an &mut reader?

`@m-ou-se` [realized][1] that because `Read` is implemented for `&mut impl
Read`, there's no need to take `&mut` in `io::read_to_string`.

Removing the `&mut` from the signature allows users to remove the `&mut`
from their calls (and thus pass an owned reader) if they don't use the
reader later.

[1]: rust-lang#80218 (comment)
@camelid camelid force-pushed the read_to_string-rm-mut branch from 2382470 to aa0ce4a Compare January 13, 2022 18:58
@m-ou-se
Copy link
Member

m-ou-se commented Jan 13, 2022

@bors r+

Thanks!

@bors
Copy link
Collaborator

bors commented Jan 13, 2022

📌 Commit aa0ce4a has been approved by m-ou-se

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 13, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 15, 2022
…askrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#92747 (Simplification of BigNum::bit_length)
 - rust-lang#92767 (Use the new language identifier for Rust in the PDB debug format)
 - rust-lang#92775 (Inline std::os::unix::ffi::OsStringExt methods)
 - rust-lang#92863 (Remove `&mut` from `io::read_to_string` signature)
 - rust-lang#92865 (Ignore static lifetimes for GATs outlives lint)
 - rust-lang#92873 (Generate more precise generator names)
 - rust-lang#92879 (Add Sync bound to allocator parameter in vec::IntoIter)
 - rust-lang#92892 (Do not fail evaluation in const blocks)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit d878ad0 into rust-lang:master Jan 15, 2022
@rustbot rustbot added this to the 1.60.0 milestone Jan 15, 2022
@camelid camelid deleted the read_to_string-rm-mut branch January 15, 2022 18:08
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-io Area: `std::io`, `std::fs`, `std::net` and `std::path` S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants