std: Account for CRLF in {str, BufRead}::lines #28034
Conversation
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
| /// | ||
| /// This does not include the empty string after a trailing `\n`. | ||
| /// This does not include the empty string after a trailing newline or CRLF. |
There was a problem hiding this comment.
This should clarify (like the BufRead one does) that the newlines are stripped from the strings that are yielded.
|
How should this change be publicized? Since it's silently breaking we need to spread the word to prevent surprises. |
|
Based on this comment I can't tell what you think of this immediate deprecation. It sounds to me that you agree we should not deprecate it now but want to anyway. |
|
I want to deprecate it now. I understand that it'll be annoying but I don't want to prevent this and all future deprecations until we have a system in place for delaying deprecation warnings. |
|
@bors: r+ |
|
📌 Commit 76011a2 has been approved by |
|
On the issue of deprecation timing: it's more relevant when we're introducing a new stable function. In this case, we're deprecating in favor of an existing function, and we should give people a heads-up about this new behavior ASAP. As far as announcing this goes, I think we should send a blast on all of our usual channels (reddit, discuss, twitter, IRC) once it lands, and then highlight it in the relnotes. I'm tagging accordingly. |
aturon
added
the
relnotes
|
☔ The latest upstream changes (presumably #28200) made this pull request unmergeable. Please resolve the merge conflicts. |
This commit is an implementation of [RFC 1212][rfc] which tweaks the behavior of
the `str::lines` and `BufRead::lines` iterators. Both iterators now account for
`\r\n` sequences in addition to `\n`, allowing for less surprising behavior
across platforms (especially in the `BufRead` case). Splitting *only* on the
`\n` character can still be achieved with `split('\n')` in both cases.
The `str::lines_any` function is also now deprecated as `str::lines` is a
drop-in replacement for it.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/1212-line-endings.md
Closes rust-lang#28032
alexcrichton
force-pushed
the
new-lines
branch
from
76011a2
to
48615a6
Compare
This commit is an implementation of [RFC 1212][rfc] which tweaks the behavior of
the `str::lines` and `BufRead::lines` iterators. Both iterators now account for
`\r\n` sequences in addition to `\n`, allowing for less surprising behavior
across platforms (especially in the `BufRead` case). Splitting *only* on the
`\n` character can still be achieved with `split('\n')` in both cases.
The `str::lines_any` function is also now deprecated as `str::lines` is a
drop-in replacement for it.
[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/1212-line-endings.md
Closes #28032
This commit is an implementation of RFC 1212 which tweaks the behavior of
the
str::linesandBufRead::linesiterators. Both iterators now account for\r\nsequences in addition to\n, allowing for less surprising behavioracross platforms (especially in the
BufReadcase). Splitting only on the\ncharacter can still be achieved withsplit('\n')in both cases.The
str::lines_anyfunction is also now deprecated asstr::linesis adrop-in replacement for it.
Closes #28032