std: Implement stdio for `std::io` #22797

alexcrichton · 2015-02-25T08:08:15Z

This is an implementation of RFC 899 and adds stdio functionality to the new
std::io module. Details of the API can be found on the RFC, but from a high
level:

io::{stdin, stdout, stderr} constructors are now available. There are also
*_raw variants for unbuffered and unlocked access.
All handles are globally shared (excluding raw variants).
The stderr handle is no longer buffered.
All handles can be explicitly locked (excluding the raw variants).

The print! and println! machinery has not yet been hooked up to these
streams just yet. The std::fmt::output module has also not yet been
implemented as part of this commit.

rust-highfive · 2015-02-25T08:08:26Z

r? @brson

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

alexcrichton · 2015-02-25T08:10:17Z

Note that this PR is not intended to be the final result of these functions. This will likely land ahead of the RFC but only because it facilitates migration to std::io where it was not previously possible. These APIs are highly likely to change and the RFC is free to diverge from this implementation (and it probably will!). I will file follow-up PRs to keep the API up-to-date with the RFC.

cc rust-lang/rfcs#899

r? @aturon API-wise
r? @retep998, @nagisa I'd like another pair of eyes on the windows implementation (and unix!)

alexcrichton · 2015-02-25T08:13:10Z

Ah I will try to add some tests soon as well. I'll both add some independent ones as well as migrate some existing run-pass/bench tests to this API.

nagisa · 2015-02-25T10:01:54Z

src/libstd/io/stdio.rs

+    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+        self.inner.write(&buf[..cmp::min(buf.len(), OUT_MAX)])
+    }
+    fn flush(&mut self) -> io::Result<()> { Ok(()) }


I believe you should just go ahead and do self.inner.flush() here, even if the inner returns Ok(()) anyway.

The inner doesn't actually implement flush in this case. Each of the underlying primitives implement write as an inherent method (taking &self) so there's no flush method to call.

It does implement it at https://github.com/rust-lang/rust/pull/22797/files#diff-c7c55a739480d5cc82ecd059127d62a9R78. I just generally prefer seeing wrapper structures like StderrLock not assume anything about the object it wraps and just pass the responsibility of doing what’s right to the object it wraps over.

Anyway that’s just a nit and general style preference, so you’re free to ignore it.

Gah sorry, was thinking of the wrong thing, I will definitely delegate!

nagisa · 2015-02-25T10:24:53Z

I’ve finished my pass over it 😉

aturon · 2015-02-25T13:25:33Z

API looks fine to me. I may want to make a few tweaks but we can work this out on the RFC. Thanks @alexcrichton!

alexcrichton · 2015-02-25T21:38:25Z

I've pushed an update that removes all *_raw and *Raw methods/primitives due to concerns about the "raw-ness" on Windows. I will delegate these primitives to the RFC instead for now. Otherwise the patch remains the same.

I have also now updated with some usage in tests as well (and will add some more over time as well).

aturon · 2015-02-27T18:39:29Z

@bors: r+ 5c0ed68

alexcrichton · 2015-02-27T19:26:55Z

@bors: r=aturon 1c32ac7

bors · 2015-02-27T21:15:28Z

⌛ Testing commit 1c32ac7 with merge a8b753b...

bors · 2015-02-27T21:19:01Z

💔 Test failed - auto-mac-32-opt

alexcrichton · 2015-02-27T21:21:02Z

@bors: retry

bors · 2015-02-28T06:00:57Z

⌛ Testing commit 1c32ac7 with merge be1f11a...

bors · 2015-02-28T06:06:17Z

💔 Test failed - auto-win-32-nopt-t

This is an implementation of RFC 899 and adds stdio functionality to the new `std::io` module. Details of the API can be found on the RFC, but from a high level: * `io::{stdin, stdout, stderr}` constructors are now available. There are also `*_raw` variants for unbuffered and unlocked access. * All handles are globally shared (excluding raw variants). * The stderr handle is no longer buffered. * All handles can be explicitly locked (excluding the raw variants). The `print!` and `println!` machinery has not yet been hooked up to these streams just yet. The `std::fmt::output` module has also not yet been implemented as part of this commit.

alexcrichton · 2015-03-01T07:32:15Z

@bors: r=aturon 94d71f8

This is an implementation of RFC 899 and adds stdio functionality to the new `std::io` module. Details of the API can be found on the RFC, but from a high level: * `io::{stdin, stdout, stderr}` constructors are now available. There are also `*_raw` variants for unbuffered and unlocked access. * All handles are globally shared (excluding raw variants). * The stderr handle is no longer buffered. * All handles can be explicitly locked (excluding the raw variants). The `print!` and `println!` machinery has not yet been hooked up to these streams just yet. The `std::fmt::output` module has also not yet been implemented as part of this commit.

bors · 2015-03-01T11:25:13Z

⌛ Testing commit 94d71f8 with merge 0c9b49c...

bors · 2015-03-01T12:54:23Z

💔 Test failed - auto-linux-64-x-android-t

pnkfelix · 2015-03-01T13:23:56Z

@bors retry

bors · 2015-03-01T14:20:13Z

⚡ Previous build results are reusable. Rebuilding only 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...

bors · 2015-03-01T14:22:57Z

💔 Test failed - auto-win-32-opt

Manishearth · 2015-03-01T14:43:09Z

@bors retry

bors · 2015-03-01T16:51:55Z

⌛ Testing commit 94d71f8 with merge 13769d8...

bors · 2015-03-01T18:21:21Z

💔 Test failed - auto-linux-64-x-android-t

sfackler · 2015-03-01T18:50:33Z

@bors retry

bors · 2015-03-01T19:34:13Z

⚡ Previous build results are reusable. Rebuilding only 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...

bors · 2015-03-01T21:01:07Z

💔 Test failed - auto-linux-64-x-android-t

Manishearth · 2015-03-01T21:35:52Z

@bors: retry

bors · 2015-03-01T22:02:56Z

⚡ Previous build results are reusable. Rebuilding only auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-x-android-t, auto-mac-32-opt, auto-mac-64-nopt-t, auto-win-32-nopt-t, auto-win-32-opt, auto-win-64-nopt-t, auto-win-64-opt...

bors · 2015-03-01T23:18:20Z

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

Manishearth · 2015-03-01T23:38:26Z

Er, what?

Second time I've seen that failure today. Looks deterministic.

sfackler · 2015-03-02T04:09:39Z

@bors retry

This is an implementation of RFC 899 and adds stdio functionality to the new `std::io` module. Details of the API can be found on the RFC, but from a high level: * `io::{stdin, stdout, stderr}` constructors are now available. There are also `*_raw` variants for unbuffered and unlocked access. * All handles are globally shared (excluding raw variants). * The stderr handle is no longer buffered. * All handles can be explicitly locked (excluding the raw variants). The `print!` and `println!` machinery has not yet been hooked up to these streams just yet. The `std::fmt::output` module has also not yet been implemented as part of this commit.

bors · 2015-03-02T07:10:15Z

⌛ Testing commit 94d71f8 with merge c514205...

bors · 2015-03-02T10:07:49Z

☀️ 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 Feb 25, 2015

rust-highfive assigned aturon and unassigned brson Feb 25, 2015

alexcrichton mentioned this pull request Feb 25, 2015

Amend RFC 517: Add material for stdio rust-lang/rfcs#899

Merged

nagisa reviewed Feb 25, 2015
View reviewed changes

aturon mentioned this pull request Feb 25, 2015

Stabilization for 1.0-beta #22500

Closed

91 tasks

alexcrichton force-pushed the io-stdio branch 2 times, most recently from e5580c7 to 8fa751d Compare February 25, 2015 21:35

alexcrichton force-pushed the io-stdio branch from 8fa751d to 5c0ed68 Compare February 25, 2015 22:15

alexcrichton force-pushed the io-stdio branch from 5c0ed68 to 1c32ac7 Compare February 27, 2015 19:26

alexcrichton force-pushed the io-stdio branch 2 times, most recently from 03e97a8 to c1854a8 Compare February 28, 2015 18:59

alexcrichton force-pushed the io-stdio branch from 51a9920 to 94d71f8 Compare March 1, 2015 07:12

Manishearth mentioned this pull request Mar 2, 2015

Fix unknown attribute in test #22944

Merged

bors merged commit 94d71f8 into rust-lang:master Mar 2, 2015

bors mentioned this pull request Mar 2, 2015

overloaded-box protocol changes #22086

Closed

BurntSushi mentioned this pull request Mar 3, 2015

Update serialize docopt/docopt.rs#108

Closed

l0kod mentioned this pull request Mar 11, 2015

Danger of leaking file descriptors when spawning processes #12148

Closed

alexcrichton deleted the io-stdio branch March 27, 2015 20:37

std: Implement stdio for std::io #22797

std: Implement stdio for std::io #22797

Conversation

alexcrichton commented Feb 25, 2015

rust-highfive commented Feb 25, 2015

alexcrichton commented Feb 25, 2015

alexcrichton commented Feb 25, 2015

nagisa Feb 25, 2015

Choose a reason for hiding this comment

alexcrichton Feb 25, 2015

Choose a reason for hiding this comment

nagisa Feb 25, 2015

Choose a reason for hiding this comment

alexcrichton Feb 25, 2015

Choose a reason for hiding this comment

nagisa commented Feb 25, 2015

aturon commented Feb 25, 2015

alexcrichton commented Feb 25, 2015

aturon commented Feb 27, 2015

alexcrichton commented Feb 27, 2015

bors commented Feb 27, 2015

bors commented Feb 27, 2015

alexcrichton commented Feb 27, 2015

bors commented Feb 28, 2015

bors commented Feb 28, 2015

alexcrichton commented Mar 1, 2015

bors commented Mar 1, 2015

bors commented Mar 1, 2015

pnkfelix commented Mar 1, 2015

bors commented Mar 1, 2015

bors commented Mar 1, 2015

Manishearth commented Mar 1, 2015

bors commented Mar 1, 2015

bors commented Mar 1, 2015

sfackler commented Mar 1, 2015

bors commented Mar 1, 2015

bors commented Mar 1, 2015

Manishearth commented Mar 1, 2015

bors commented Mar 1, 2015

bors commented Mar 1, 2015

Manishearth commented Mar 1, 2015

sfackler commented Mar 2, 2015

bors commented Mar 2, 2015

bors commented Mar 2, 2015

std: Implement stdio for `std::io` #22797

std: Implement stdio for `std::io` #22797