diff options
| author | Corey Farwell <coreyf@rwell.org> | 2018-08-14 08:37:12 -0400 |
|---|---|---|
| committer | Corey Farwell <coreyf@rwell.org> | 2018-08-14 21:32:11 -0400 |
| commit | d1193bf95e9a51d842d8091ee3f30aebe697f75b (patch) | |
| tree | 8a122b98a2f17727741969446febe4fd9667a522 /src/liballoc | |
| parent | 5bb923988f949639f11dba0c1ab1980fe8dfec3d (diff) | |
| download | rust-d1193bf95e9a51d842d8091ee3f30aebe697f75b.tar.gz rust-d1193bf95e9a51d842d8091ee3f30aebe697f75b.zip | |
Add doc examples for std::alloc::{alloc,alloc_zeroed}.
Diffstat (limited to 'src/liballoc')
| -rw-r--r-- | src/liballoc/alloc.rs | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/liballoc/alloc.rs b/src/liballoc/alloc.rs index 84bd275df34..c69b2fb5e1c 100644 --- a/src/liballoc/alloc.rs +++ b/src/liballoc/alloc.rs @@ -56,6 +56,22 @@ pub struct Global; /// # Safety /// /// See [`GlobalAlloc::alloc`]. +/// +/// # Examples +/// +/// ``` +/// use std::alloc::{alloc, dealloc, Layout}; +/// +/// unsafe { +/// let layout = Layout::new::<u16>(); +/// let ptr = alloc(layout); +/// +/// *(ptr as *mut u16) = 42; +/// assert_eq!(*(ptr as *mut u16), 42); +/// +/// dealloc(ptr, layout); +/// } +/// ``` #[stable(feature = "global_alloc", since = "1.28.0")] #[inline] pub unsafe fn alloc(layout: Layout) -> *mut u8 { @@ -110,6 +126,21 @@ pub unsafe fn realloc(ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8 /// # Safety /// /// See [`GlobalAlloc::alloc_zeroed`]. +/// +/// # Examples +/// +/// ``` +/// use std::alloc::{alloc_zeroed, dealloc, Layout}; +/// +/// unsafe { +/// let layout = Layout::new::<u16>(); +/// let ptr = alloc_zeroed(layout); +/// +/// assert_eq!(*(ptr as *mut u16), 0); +/// +/// dealloc(ptr, layout); +/// } +/// ``` #[stable(feature = "global_alloc", since = "1.28.0")] #[inline] pub unsafe fn alloc_zeroed(layout: Layout) -> *mut u8 { |
