std: Stabilize the `io` module #23292

alexcrichton · 2015-03-11T22:59:32Z

The new std::io module has had some time to bake now, and this commit
stabilizes its functionality. There are still portions of the module which
remain unstable, and below contains a summart of the actions taken.

This commit also deprecates the entire contents of the old_io module in a
blanket fashion. All APIs should now have a reasonable replacement in the
new I/O modules.

Stable APIs:

std::io (the name)
std::io::prelude (the name)
Read
Read::read
Read::{read_to_end, read_to_string} after being modified to return a usize
for the number of bytes read.
ReadExt
Write
Write::write
Write::{write_all, write_fmt}
WriteExt
BufRead
BufRead::{fill_buf, consume}
BufRead::{read_line, read_until} after being modified to return a usize
for the number of bytes read.
BufReadExt
BufReader
BufReader::{new, with_capacity}
BufReader::{get_ref, get_mut, into_inner}
{Read,BufRead} for BufReader
BufWriter
BufWriter::{new, with_capacity}
BufWriter::{get_ref, get_mut, into_inner}
Write for BufWriter
IntoInnerError
IntoInnerError::{error, into_inner}
{Error,Display} for IntoInnerError
LineWriter
LineWriter::{new, with_capacity} - with_capacity was added
LineWriter::{get_ref, get_mut, into_inner} - get_mut was added)
Write for LineWriter
BufStream
BufStream::{new, with_capacities}
BufStream::{get_ref, get_mut, into_inner}
{BufRead,Read,Write} for BufStream
stdin
Stdin
Stdin::lock
Stdin::read_line - added method
StdinLock
Read for Stdin
{Read,BufRead} for StdinLock
stdout
Stdout
Stdout::lock
StdoutLock
Write for Stdout
Write for StdoutLock
stderr
Stderr
Stderr::lock
StderrLock
Write for Stderr
Write for StderrLock
io::Result
io::Error
io::Error::last_os_error
{Display, Error} for Error

Unstable APIs:

(reasons can be found in the commit itself)

Write::flush
Seek
ErrorKind
Error::new
Error::from_os_error
Error::kind

Deprecated APIs

Error::description - available via the Error trait
Error::detail - available via the Display implementation
thread::Builder::{stdout, stderr}

Changes in functionality:

old_io::stdio::set_stderr is now a noop as the infrastructure for printing
backtraces has migrated to std::io.

[breaking-change]

alexcrichton · 2015-03-11T22:59:39Z

r? @aturon

rust-highfive · 2015-03-11T22:59:44Z

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

alexcrichton · 2015-03-11T23:29:42Z

Note that in the fallout commit I have duplicated "TTY detection" between libtest and libsyntax as well as a structure to replace Chan{Reader,Writer} in rustc_driver/libtest. The current set_stderr interface is now a noop, but I replaced it with a set_panic hidden function (unstable) in std::io. I don't want to regress functionality in terms of quality of compiler diagnostics as well as test output for now, so we can reconsider the function later on.

bors · 2015-03-12T07:37:18Z

☔ The latest upstream changes (presumably #23298) made this pull request unmergeable. Please resolve the merge conflicts.

alexcrichton · 2015-03-12T18:43:40Z

I've modified the first commit to remove the FooExt traits by folding functionality with where Self: Sized into the main Read/Write/BufRead traits.

aturon · 2015-03-12T19:14:14Z

Really, really exciting. What a long haul!

@bors: r+ b1f2158

aturon · 2015-03-12T19:14:37Z

(I left some very minor nits, feel free to fix when it bounces ;-)

alexcrichton · 2015-03-12T19:38:01Z

@bors: r=aturon 8bf14f7

bors · 2015-03-12T20:18:59Z

☔ The latest upstream changes (presumably #23245) made this pull request unmergeable. Please resolve the merge conflicts.

alexcrichton · 2015-03-13T03:55:37Z

@bors: r=aturon

bors · 2015-03-13T03:55:37Z

~~@bors r=aturon 2442589~~

bors · 2015-03-13T05:33:17Z

⌛ Testing commit 2442589 with merge b3554cb...

bors · 2015-03-13T05:53:16Z

💔 Test failed - auto-mac-64-nopt-t

alexcrichton · 2015-03-13T05:55:55Z

@bors: r=aturon

On Thu, Mar 12, 2015 at 10:53 PM, bors notifications@github.com wrote:

[image: 💔] Test failed - auto-mac-64-nopt-t
http://buildbot.rust-lang.org/builders/auto-mac-64-nopt-t/builds/4064

—
Reply to this email directly or view it on GitHub
#23292 (comment).

bors · 2015-03-13T05:55:56Z

~~@bors r=aturon 2597c05~~

bors · 2015-03-13T08:01:28Z

⌛ Testing commit 2597c05 with merge a7be711...

bors · 2015-03-13T09:36:46Z

💔 Test failed - auto-mac-32-opt

alexcrichton · 2015-03-13T17:01:07Z

@bors: r=aturon 981bf5f

bors · 2015-03-13T17:46:30Z

⌛ Testing commit 981bf5f with merge 5f2f914...

bors · 2015-03-13T17:49:14Z

⛄ The build was interrupted to prioritize another pull request.

bors · 2015-03-13T20:22:17Z

⌛ Testing commit 981bf5f with merge 3e4be02...

The new `std::io` module has had some time to bake now, and this commit stabilizes its functionality. There are still portions of the module which remain unstable, and below contains a summart of the actions taken. This commit also deprecates the entire contents of the `old_io` module in a blanket fashion. All APIs should now have a reasonable replacement in the new I/O modules. Stable APIs: * `std::io` (the name) * `std::io::prelude` (the name) * `Read` * `Read::read` * `Read::{read_to_end, read_to_string}` after being modified to return a `usize` for the number of bytes read. * `ReadExt` * `Write` * `Write::write` * `Write::{write_all, write_fmt}` * `WriteExt` * `BufRead` * `BufRead::{fill_buf, consume}` * `BufRead::{read_line, read_until}` after being modified to return a `usize` for the number of bytes read. * `BufReadExt` * `BufReader` * `BufReader::{new, with_capacity}` * `BufReader::{get_ref, get_mut, into_inner}` * `{Read,BufRead} for BufReader` * `BufWriter` * `BufWriter::{new, with_capacity}` * `BufWriter::{get_ref, get_mut, into_inner}` * `Write for BufWriter` * `IntoInnerError` * `IntoInnerError::{error, into_inner}` * `{Error,Display} for IntoInnerError` * `LineWriter` * `LineWriter::{new, with_capacity}` - `with_capacity` was added * `LineWriter::{get_ref, get_mut, into_inner}` - `get_mut` was added) * `Write for LineWriter` * `BufStream` * `BufStream::{new, with_capacities}` * `BufStream::{get_ref, get_mut, into_inner}` * `{BufRead,Read,Write} for BufStream` * `stdin` * `Stdin` * `Stdin::lock` * `Stdin::read_line` - added method * `StdinLock` * `Read for Stdin` * `{Read,BufRead} for StdinLock` * `stdout` * `Stdout` * `Stdout::lock` * `StdoutLock` * `Write for Stdout` * `Write for StdoutLock` * `stderr` * `Stderr` * `Stderr::lock` * `StderrLock` * `Write for Stderr` * `Write for StderrLock` * `io::Result` * `io::Error` * `io::Error::last_os_error` * `{Display, Error} for Error` Unstable APIs: (reasons can be found in the commit itself) * `Write::flush` * `Seek` * `ErrorKind` * `Error::new` * `Error::from_os_error` * `Error::kind` Deprecated APIs * `Error::description` - available via the `Error` trait * `Error::detail` - available via the `Display` implementation * `thread::Builder::{stdout, stderr}` Changes in functionality: * `old_io::stdio::set_stderr` is now a noop as the infrastructure for printing backtraces has migrated to `std::io`. [breaking-change]

bors · 2015-03-13T22:51:06Z

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-32-nopt-t, auto-win-32-opt, auto-win-64-nopt-t, auto-win-64-opt

rust-highfive assigned brson Mar 11, 2015

rust-highfive assigned aturon and unassigned brson Mar 11, 2015

alexcrichton force-pushed the stabilize-io branch from b50eafc to c79ce2c Compare March 11, 2015 23:28

huonw mentioned this pull request Mar 11, 2015

Tracking issue for RFC 517: IO reform #21070

Closed

10 tasks

aturon mentioned this pull request Mar 11, 2015

Stabilization for 1.0-beta #22500

Closed

91 tasks

alexcrichton force-pushed the stabilize-io branch 12 times, most recently from de59d81 to 0473a27 Compare March 12, 2015 00:54

alexcrichton force-pushed the stabilize-io branch 2 times, most recently from f5eebbd to b1f2158 Compare March 12, 2015 18:43

alexcrichton force-pushed the stabilize-io branch from b1f2158 to 8bf14f7 Compare March 12, 2015 19:37

alexcrichton force-pushed the stabilize-io branch from 2442589 to 2597c05 Compare March 13, 2015 05:55

Fallout of std::old_io deprecation

981bf5f

alexcrichton force-pushed the stabilize-io branch from 2597c05 to 981bf5f Compare March 13, 2015 17:00

bors merged commit 981bf5f into rust-lang:master Mar 13, 2015

This was referenced Mar 13, 2015

implements read_into_string/read_into_vec for Read trait #23335

Closed

overloaded-box protocol changes #22086

Closed

Use new io in print and println macroses #23206

Merged

Remove explicit syntax highlight from docs. #23329

Merged

Ms2ger added a commit to servo/rust-png that referenced this pull request Mar 21, 2015

Update for <rust-lang/rust#23292>.

6a82f63

Ms2ger added a commit to servo/rust-png that referenced this pull request Mar 21, 2015

fixup! Update for <rust-lang/rust#23292>.

82eadd9

Ms2ger added a commit to servo/rust-png that referenced this pull request Mar 21, 2015

Update for <rust-lang/rust#23292>.

5b75232

Ms2ger added a commit to servo/rust-png that referenced this pull request Mar 21, 2015

Update for <rust-lang/rust#23292>.

9b60b8f

alexcrichton deleted the stabilize-io branch March 27, 2015 20:42

std: Stabilize the io module #23292

std: Stabilize the io module #23292

Uh oh!

Conversation

alexcrichton commented Mar 11, 2015

Uh oh!

alexcrichton commented Mar 11, 2015

Uh oh!

rust-highfive commented Mar 11, 2015

Uh oh!

alexcrichton commented Mar 11, 2015

Uh oh!

bors commented Mar 12, 2015

Uh oh!

alexcrichton commented Mar 12, 2015

Uh oh!

aturon commented Mar 12, 2015

Uh oh!

aturon commented Mar 12, 2015

Uh oh!

alexcrichton commented Mar 12, 2015

Uh oh!

bors commented Mar 12, 2015

Uh oh!

alexcrichton commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

alexcrichton commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

alexcrichton commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

bors commented Mar 13, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

std: Stabilize the `io` module #23292

std: Stabilize the `io` module #23292