Skip to content

Improve std::thread::Result documentation #66114

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 7, 2019
Merged

Improve std::thread::Result documentation #66114

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
002c1c7
Improve std::thread::Result documentation
golddranks Nov 5, 2019
f1bc4ef
Addressed review comments.
golddranks Nov 6, 2019
4317263
Fix the Error linking.
golddranks Nov 6, 2019
8568204
Try with crate::error::Error
golddranks Nov 6, 2019
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
12 changes: 12 additions & 0 deletions src/libstd/thread/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1271,6 +1271,18 @@ impl fmt::Debug for Thread {
///
/// Indicates the manner in which a thread exited.
///
/// The value contained in the `Result::Err` variant
/// is the value the thread panicked with;
/// that is, the parameter the `panic!` macro was called with.
/// Unlike with normal errors, this value doesn't implement
/// the `std::error::Error` trait.
///
/// Thus, a sensible way to handle a thread panic is to either
/// `unwrap` the `Result`, propagating the panic,
/// or in case the thread is intended to be a subsystem boundary
/// that is supposed to isolate system-level failures,
/// match for the `Err` variant and handle the panic in an appropriate way.
///
/// A thread that completes without panicking is considered to exit successfully.
///
/// # Examples
Expand Down