mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #120266 - steffahn:a_rc_into_inner_docs, r=Mark-Simulacrum

Browse Source 
Improve documentation for [A]Rc::into_inner

General improvements, and also aims to better encourage the reader to actually check out Arc::try_unwrap.

This addresses concerns from https://github.com/rust-lang/rust/issues/106894#issuecomment-1905627234.

Rendered:

![Screenshot_20240123_114436](https://github.com/rust-lang/rust/assets/3986214/68896d62-13e0-4f3a-8073-91d8e77c5554)
![Screenshot_20240123_114455](https://github.com/rust-lang/rust/assets/3986214/dc58e4bd-dd7f-40b1-bc50-fd6200dde593)
This commit is contained in:
Dylan DPC 2024-01-29 12:56:52 +00:00 committed by GitHub
commit 4528b37196
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
library/alloc/src/rc.rs
View File

@ -939,8 +939,11 @@ impl<T, A: Allocator> Rc<T, A> {
/// it is guaranteed that exactly one of the calls returns the inner value. /// it is guaranteed that exactly one of the calls returns the inner value.
/// This means in particular that the inner value is not dropped. /// This means in particular that the inner value is not dropped.
/// ///
/// This is equivalent to `Rc::try_unwrap(this).ok()`. (Note that these are not equivalent for /// [`Rc::try_unwrap`] is conceptually similar to `Rc::into_inner`.
/// [`Arc`](crate::sync::Arc), due to race conditions that do not apply to `Rc`.) /// And while they are meant for different use-cases, `Rc::into_inner(this)`
/// is in fact equivalent to <code>[Rc::try_unwrap]\(this).[ok][Result::ok]()</code>.
/// (Note that the same kind of equivalence does **not** hold true for
/// [`Arc`](crate::sync::Arc), due to race conditions that do not apply to `Rc`!)
#[inline] #[inline]
#[stable(feature = "rc_into_inner", since = "1.70.0")] #[stable(feature = "rc_into_inner", since = "1.70.0")]
pub fn into_inner(this: Self) -> Option<T> { pub fn into_inner(this: Self) -> Option<T> {

10
library/alloc/src/sync.rs
View File

@ -983,9 +983,13 @@ impl<T, A: Allocator> Arc<T, A> {
/// it is guaranteed that exactly one of the calls returns the inner value. /// it is guaranteed that exactly one of the calls returns the inner value.
/// This means in particular that the inner value is not dropped. /// This means in particular that the inner value is not dropped.
/// ///
/// The similar expression `Arc::try_unwrap(this).ok()` does not /// [`Arc::try_unwrap`] is conceptually similar to `Arc::into_inner`, but it
/// offer such a guarantee. See the last example below /// is meant for different use-cases. If used as a direct replacement
/// and the documentation of [`Arc::try_unwrap`]. /// for `Arc::into_inner` anyway, such as with the expression
/// <code>[Arc::try_unwrap]\(this).[ok][Result::ok]()</code>, then it does
/// **not** give the same guarantee as described in the previous paragraph.
/// For more information, see the examples below and read the documentation
/// of [`Arc::try_unwrap`].
/// ///
/// # Examples /// # Examples
/// ///