diff options
| author | Evan Simmons <esims89@gmail.com> | 2018-08-17 21:21:00 -0600 |
|---|---|---|
| committer | Evan Simmons <esims89@gmail.com> | 2018-08-20 10:56:16 -0600 |
| commit | de35b66783278a16d2de35ddcc11b397be04c473 (patch) | |
| tree | 92efb2bbfa8ac53189422714a4958ea2a4b6441c /src/liballoc | |
| parent | 4d5ef325e060743cba2ef587912f40b8b3b87cc4 (diff) | |
| download | rust-de35b66783278a16d2de35ddcc11b397be04c473.tar.gz rust-de35b66783278a16d2de35ddcc11b397be04c473.zip | |
Document Box::into_raw returns non-null ptr
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 |