mirror of
https://github.com/rust-lang/rust.git
synced 2024-10-31 06:22:00 +00:00
Rollup merge of #84083 - ltratt:threadid_doc_tweak, r=dtolnay
Clarify the guarantees that ThreadId does and doesn't make. The existing documentation does not spell out whether `ThreadId`s are unique during the lifetime of a thread or of a process. I had to examine the source code to realise (pleasingly!) that they're unique for the lifetime of a process. That seems worth documenting clearly, as it's a strong guarantee. Examining the way `ThreadId`s are created also made me realise that the `as_u64` method on `ThreadId` could be a trap for the unwary on those platforms where the platform's notion of a thread identifier is also a 64 bit integer (particularly if they happen to use a similar identifier scheme to `ThreadId`). I therefore think it's worth being even clearer that there's no relationship between the two.
This commit is contained in:
commit
30ec1f0384
@ -972,10 +972,13 @@ pub fn park_timeout(dur: Duration) {
|
||||
|
||||
/// A unique identifier for a running thread.
|
||||
///
|
||||
/// A `ThreadId` is an opaque object that has a unique value for each thread
|
||||
/// that creates one. `ThreadId`s are not guaranteed to correspond to a thread's
|
||||
/// system-designated identifier. A `ThreadId` can be retrieved from the [`id`]
|
||||
/// method on a [`Thread`].
|
||||
/// A `ThreadId` is an opaque object that uniquely identifies each thread
|
||||
/// created during the lifetime of a process. `ThreadId`s are guaranteed not to
|
||||
/// be reused, even when a thread terminates. `ThreadId`s are under the control
|
||||
/// of Rust's standard library and there may not be any relationship between
|
||||
/// `ThreadId` and the underlying platform's notion of a thread identifier --
|
||||
/// the two concepts cannot, therefore, be used interchangeably. A `ThreadId`
|
||||
/// can be retrieved from the [`id`] method on a [`Thread`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
|
Loading…
Reference in New Issue
Block a user