bjoernager/rust
bjoernager/rust
1
Fork 0
Code Issues Pull requests Activity

Indicate thread names get passed to the OS.

Browse source
This commit is contained in:
Corey Farwell 2017-08-13 16:23:13 -04:00
parent 150713ce9f
commit 10bd80d79b
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/libstd/thread/mod.rs
View file

@ -114,10 +114,14 @@
//! //!
//! ## Naming threads //! ## Naming threads
//! //!
//! Threads are able to have associated names for identification purposes. For example, the thread //! Threads are able to have associated names for identification purposes. By default, spawned
//! name is used in panic messages. By default, spawned threads are unnamed. To specify a name for //! threads are unnamed. To specify a name for a thread, build the thread with [`Builder`] and pass
//! a thread, build the thread with [`Builder`] and pass the desired thread name to //! the desired thread name to [`Builder::name`]. To retrieve the thread name from within the
//! [`Builder::name`]. To retrieve the thread name from within the thread, use [`Thread::name`]. //! thread, use [`Thread::name`]. A couple examples of where the name of a thread gets used:
//!
//! * If a panic occurs in a named thread, the thread name will be printed in the panic message.
//! * The thread name is provided to the OS where applicable (e.g. `pthread_setname_np` in
//! unix-like platforms).
//! //!
//! ## Stack size //! ## Stack size
//! //!