Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Don't panic when stdout doesn't exist #1014

Merged
merged 4 commits into from
Jun 2, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions 0000-stdout-existential-crisis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- Feature Name: stdout_existential_crisis
- Start Date: 2015-03-25
- RFC PR: (leave this empty)
- Rust Issue: (leave this empty)

# Summary

When calling `println!` it currently causes a panic if `stdout` does not exist. Change this to ignore this specific error and simply void the output.

# Motivation

On Linux `stdout` almost always exists, so when people write games and turn off the terminal there is still an `stdout` that they write to. Then when getting the code to run on Windows, when the console is disabled, suddenly `stdout` doesn't exist and `println!` panicks. This behavior difference is frustrating to developers trying to move to Windows.

There is also precedent with C and C++. On both Linux and Windows, if `stdout` is closed or doesn't exist, neither platform will error when attempting to print to the console.

# Detailed design

When using any of the convenience macros that write to either `stdout` or `stderr`, such as `println!` `print!` `panic!` and `assert!`, change the implementation to ignore the specific error of `stdout` or `stderr` not existing. The behavior of all other errors will be unaffected. This can be implemented by redirecting `stdout` and `stderr` to `std::io::sink` if the original handles do not exist.

Update the methods `std::io::stdin` `std::io::stdout` and `std::io::stderr` as follows:
* If `stdout` or `stderr` does not exist, return the equivalent of `std::io::sink`.
* If `stdin` does not exist, return the equivalent of `std::io::empty`.
* For the raw versions, return a `Result`, and if the respective handle does not exist, return an `Err`.

# Drawbacks
Copy link
Member

Choose a reason for hiding this comment

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

It may be worth noting that languages like Ruby and Python throw an exception when printing with a missing stdout.


* Hides an error from the user which we may want to expose and may lead to people missing panicks occuring in threads.
* Some languages, such as Ruby and Python, do throw an exception when stdout is missing.

# Alternatives

* Make `println!` `print!` `panic!` `assert!` return errors that the user has to handle. This would lose a large part of the convenience of these macros.
* Continue with the status quo and panic if `stdout` or `stderr` doesn't exist.
* For `std::io::stdin` `std::io::stdout` and `std::io::stderr`, make them return a `Result`. This would be a breaking change to the signature, so if this is desired it should be done immediately before 1.0.
** Alternatively, make the objects returned by these methods error upon attempting to write to/read from them if their respective handle doesn't exist.

# Unresolved questions

* Which is better? Breaking the signatures of those three methods in `std::io`, making them silently redirect to `empty`/`sink`, or erroring upon attempting to write to/read from the handle?