Skip to content

Commit

Permalink
std: Switch stdout/stderr to buffered by default
Browse files Browse the repository at this point in the history
Similarly to #12422 which made stdin buffered by default, this commit makes the
output streams also buffered by default. Now that buffered writers will flush
their contents when they are dropped, I don't believe that there's no reason why
the output shouldn't be buffered by default, which is what you want in 90% of
cases.

As with stdin, there are new stdout_raw() and stderr_raw() functions to get
unbuffered streams to stdout/stderr.
  • Loading branch information
alexcrichton committed Mar 1, 2014
1 parent 1ee94a1 commit 2cb83fd
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 21 deletions.
3 changes: 1 addition & 2 deletions src/librustc/lib.rs
Expand Up @@ -297,8 +297,7 @@ pub fn run_compiler(args: &[~str]) {
match input {
d::FileInput(ref ifile) => {
let mut stdout = io::stdout();
d::list_metadata(sess, &(*ifile),
&mut stdout as &mut io::Writer).unwrap();
d::list_metadata(sess, &(*ifile), &mut stdout).unwrap();
}
d::StrInput(_) => {
d::early_error("can not list metadata for stdin");
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/fmt/mod.rs
Expand Up @@ -654,8 +654,8 @@ uniform_fn_call_workaround! {
/// use std::fmt;
/// use std::io;
///
/// let w = &mut io::stdout() as &mut io::Writer;
/// format_args!(|args| { fmt::write(w, args); }, "Hello, {}!", "world");
/// let mut w = io::stdout();
/// format_args!(|args| { fmt::write(&mut w, args); }, "Hello, {}!", "world");
/// ```
pub fn write(output: &mut io::Writer, args: &Arguments) -> Result {
unsafe { write_unsafe(output, args.fmt, args.args) }
Expand Down
34 changes: 29 additions & 5 deletions src/libstd/io/stdio.rs
Expand Up @@ -90,6 +90,12 @@ fn src<T>(fd: libc::c_int, readable: bool, f: |StdSource| -> T) -> T {
/// buffered access is not desired, the `stdin_raw` function is provided to
/// provided unbuffered access to stdin.
///
/// Care should be taken when creating multiple handles to the stdin of a
/// process. Beause this is a buffered reader by default, it's possible for
/// pending input to be unconsumed in one reader and unavailable to other
/// readers. It is recommended that only one handle at a time is created for the
/// stdin of a process.
///
/// See `stdout()` for more notes about this function.
pub fn stdin() -> BufferedReader<StdReader> {
BufferedReader::new(stdin_raw())
Expand All @@ -104,20 +110,38 @@ pub fn stdin_raw() -> StdReader {
src(libc::STDIN_FILENO, true, |src| StdReader { inner: src })
}

/// Creates a new non-blocking handle to the stdout of the current process.
/// Creates a line-buffered handle to the stdout of the current process.
///
/// Note that this is a fairly expensive operation in that at least one memory
/// allocation is performed. Additionally, this must be called from a runtime
/// task context because the stream returned will be a non-blocking object using
/// the local scheduler to perform the I/O.
pub fn stdout() -> StdWriter {
///
/// Care should be taken when creating multiple handles to an output stream for
/// a single process. While usage is still safe, the output may be surprising if
/// no synchronization is performed to ensure a sane output.
pub fn stdout() -> LineBufferedWriter<StdWriter> {
LineBufferedWriter::new(stdout_raw())
}

/// Creates an unbuffered handle to the stdout of the current process
///
/// See notes in `stdout()` for more information.
pub fn stdout_raw() -> StdWriter {
src(libc::STDOUT_FILENO, false, |src| StdWriter { inner: src })
}

/// Creates a new non-blocking handle to the stderr of the current process.
/// Creates a line-buffered handle to the stderr of the current process.
///
/// See `stdout()` for notes about this function.
pub fn stderr() -> StdWriter {
pub fn stderr() -> LineBufferedWriter<StdWriter> {
LineBufferedWriter::new(stderr_raw())
}

/// Creates an unbuffered handle to the stderr of the current process
///
/// See notes in `stdout()` for more information.
pub fn stderr_raw() -> StdWriter {
src(libc::STDERR_FILENO, false, |src| StdWriter { inner: src })
}

Expand Down Expand Up @@ -182,7 +206,7 @@ fn with_task_stdout(f: |&mut Writer| -> IoResult<()> ) {
Local::put(task);

if my_stdout.is_none() {
my_stdout = Some(~LineBufferedWriter::new(stdout()) as ~Writer);
my_stdout = Some(~stdout() as ~Writer);
}
let ret = f(*my_stdout.get_mut_ref());

Expand Down
4 changes: 1 addition & 3 deletions src/libstd/logging.rs
Expand Up @@ -166,9 +166,7 @@ pub fn log(level: u32, args: &fmt::Arguments) {
};

if logger.is_none() {
logger = Some(~DefaultLogger {
handle: LineBufferedWriter::new(io::stderr()),
} as ~Logger);
logger = Some(~DefaultLogger { handle: io::stderr(), } as ~Logger);
}
logger.get_mut_ref().log(level, args);

Expand Down
4 changes: 2 additions & 2 deletions src/libsyntax/diagnostic.rs
Expand Up @@ -227,8 +227,8 @@ enum Destination {
impl EmitterWriter {
pub fn stderr() -> EmitterWriter {
let stderr = io::stderr();
if stderr.isatty() {
let dst = match term::Terminal::new(stderr) {
if stderr.get_ref().isatty() {
let dst = match term::Terminal::new(stderr.unwrap()) {
Ok(t) => Terminal(t),
Err(..) => Raw(~io::stderr()),
};
Expand Down
4 changes: 2 additions & 2 deletions src/libtest/lib.rs
Expand Up @@ -415,8 +415,8 @@ impl<T: Writer> ConsoleTestState<T> {
Some(ref path) => Some(try!(File::create(path))),
None => None
};
let out = match term::Terminal::new(io::stdout()) {
Err(_) => Raw(io::stdout()),
let out = match term::Terminal::new(io::stdio::stdout_raw()) {
Err(_) => Raw(io::stdio::stdout_raw()),
Ok(t) => Pretty(t)
};
Ok(ConsoleTestState {
Expand Down
4 changes: 2 additions & 2 deletions src/test/bench/shootout-fasta-redux.rs
Expand Up @@ -9,7 +9,7 @@
// except according to those terms.

use std::cmp::min;
use std::io::{stdout, BufferedWriter, IoResult};
use std::io::{stdout, IoResult};
use std::os;
use std::vec::bytes::copy_memory;
use std::vec;
Expand Down Expand Up @@ -183,7 +183,7 @@ fn main() {
5
};

let mut out = BufferedWriter::new(stdout());
let mut out = stdout();

out.write_line(">ONE Homo sapiens alu").unwrap();
{
Expand Down
2 changes: 1 addition & 1 deletion src/test/bench/shootout-fasta.rs
Expand Up @@ -117,6 +117,6 @@ fn main() {
let mut file = BufferedWriter::new(File::create(&Path::new("./shootout-fasta.data")));
run(&mut file);
} else {
run(&mut BufferedWriter::new(io::stdout()));
run(&mut io::stdout());
}
}
3 changes: 1 addition & 2 deletions src/test/bench/shootout-mandelbrot.rs
Expand Up @@ -9,7 +9,6 @@
// except according to those terms.

use std::io;
use std::io::BufferedWriter;

struct DummyWriter;
impl Writer for DummyWriter {
Expand All @@ -27,7 +26,7 @@ fn main() {
(1000, ~DummyWriter as ~Writer)
} else {
(from_str(args[1]).unwrap(),
~BufferedWriter::new(std::io::stdout()) as ~Writer)
~std::io::stdout() as ~Writer)
};
let h = w;
let mut byte_acc = 0u8;
Expand Down

5 comments on commit 2cb83fd

@bors
Copy link
Contributor

@bors bors commented on 2cb83fd Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from brson
at alexcrichton@2cb83fd

@bors
Copy link
Contributor

@bors bors commented on 2cb83fd Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging alexcrichton/rust/flush-buffered = 2cb83fd into auto

@bors
Copy link
Contributor

@bors bors commented on 2cb83fd Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alexcrichton/rust/flush-buffered = 2cb83fd merged ok, testing candidate = 999d55d

@bors
Copy link
Contributor

@bors bors commented on 2cb83fd Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bors
Copy link
Contributor

@bors bors commented on 2cb83fd Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = 999d55d

Please sign in to comment.