diff options
| author | kennytm <kennytm@gmail.com> | 2018-08-21 11:09:03 +0800 |
|---|---|---|
| committer | kennytm <kennytm@gmail.com> | 2018-08-21 17:51:59 +0800 |
| commit | fed4298aed281ef34c04be4d63711dbc46b6d95b (patch) | |
| tree | d7ac496565daa5bab5f370728fa7ec73d8cbd7fc /src/liballoc | |
| parent | 7896ac3e08c7ff4c0943dc1ff48dbb9e9c316992 (diff) | |
| parent | de35b66783278a16d2de35ddcc11b397be04c473 (diff) | |
| download | rust-fed4298aed281ef34c04be4d63711dbc46b6d95b.tar.gz rust-fed4298aed281ef34c04be4d63711dbc46b6d95b.zip | |
Rollup merge of #53462 - estk:doc-Box_into_raw, r=steveklabnik
Document Box::into_raw returns non-null ptr Closes #52806.
Diffstat (limited to 'src/liballoc')
| -rw-r--r-- | src/liballoc/boxed.rs | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/liballoc/boxed.rs b/src/liballoc/boxed.rs index 08db5136d04..105bf855013 100644 --- a/src/liballoc/boxed.rs +++ b/src/liballoc/boxed.rs @@ -126,7 +126,9 @@ impl<T: ?Sized> Box<T> { Box(Unique::new_unchecked(raw)) } - /// Consumes the `Box`, returning the wrapped raw pointer. + /// Consumes the `Box`, returning a wrapped raw pointer. + /// + /// The pointer will be properly aligned and non-null. /// /// After calling this function, the caller is responsible for the /// memory previously managed by the `Box`. In particular, the |