W3cubDocs

/Rust

Struct std::heap::Heap

pub struct Heap;

🔬 This is a nightly-only experimental API. (allocator_api #32838)the precise API and guarantees it provides may be tweaked slightly, especially to possibly take into account the types being stored to make room for a future tracing garbage collector

Trait Implementations

`impl Default for Heap` [src]

`fn default() -> Heap` [src]

Returns the "default value" for a type. Read more

`impl Debug for Heap` [src]

`fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>` [src]

Formats the value using the given formatter. Read more

`impl Alloc for Heap` [src]

`unsafe fn alloc(&mut self, layout: Layout) -> Result<*mut u8, AllocErr>` [src]

Returns a pointer meeting the size and alignment guarantees of layout. Read more

`fn oom(&mut self, err: AllocErr) -> !` [src]

Allocator-specific method for signaling an out-of-memory condition. Read more

`unsafe fn dealloc(&mut self, ptr: *mut u8, layout: Layout)` [src]

Deallocate the memory referenced by ptr. Read more

`fn usable_size(&self, layout: &Layout) -> (usize, usize)` [src]

Returns bounds on the guaranteed usable size of a successful allocation created with the specified layout. Read more

`unsafe fn realloc( &mut self, ptr: mut u8, layout: Layout, new_layout: Layout ) -> Result<mut u8, AllocErr>` [src]

Returns a pointer suitable for holding data described by new_layout, meeting its size and alignment guarantees. To accomplish this, this may extend or shrink the allocation referenced by ptr to fit new_layout. Read more

`unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<*mut u8, AllocErr>` [src]

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more

`unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr>` [src]

Behaves like alloc, but also returns the whole size of the returned block. For some layout inputs, like arrays, this may include extra storage usable for additional data. Read more

`unsafe fn realloc_excess( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout ) -> Result<Excess, AllocErr>` [src]

Behaves like realloc, but also returns the whole size of the returned block. For some layout inputs, like arrays, this may include extra storage usable for additional data. Read more

`unsafe fn grow_in_place( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout ) -> Result<(), CannotReallocInPlace>` [src]

Attempts to extend the allocation referenced by ptr to fit new_layout. Read more

`unsafe fn shrink_in_place( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout ) -> Result<(), CannotReallocInPlace>` [src]

Attempts to shrink the allocation referenced by ptr to fit new_layout. Read more

`fn alloc_one<T>(&mut self) -> Result<Unique<T>, AllocErr>` [src]

Allocates a block suitable for holding an instance of T. Read more

`unsafe fn dealloc_one<T>(&mut self, ptr: Unique<T>)` [src]

Deallocates a block suitable for holding an instance of T. Read more

`fn alloc_array<T>(&mut self, n: usize) -> Result<Unique<T>, AllocErr>` [src]

Allocates a block suitable for holding n instances of T. Read more

`unsafe fn realloc_array<T>( &mut self, ptr: Unique<T>, n_old: usize, n_new: usize ) -> Result<Unique<T>, AllocErr>` [src]

Reallocates a block previously suitable for holding n_old instances of T, returning a block suitable for holding n_new instances of T. Read more

`unsafe fn dealloc_array<T>( &mut self, ptr: Unique<T>, n: usize ) -> Result<(), AllocErr>` [src]

Deallocates a block suitable for holding n instances of T. Read more

`impl Clone for Heap` [src]

`fn clone(&self) -> Heap` [src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Copy for Heap` [src]

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/heap/struct.Heap.html

Struct std::heap::Heap

Trait Implementations

impl Default for Heap [src]

fn default() -> Heap [src]

impl Debug for Heap [src]

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error> [src]

impl Alloc for Heap [src]

unsafe fn alloc(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> [src]

fn oom(&mut self, err: AllocErr) -> ! [src]

unsafe fn dealloc(&mut self, ptr: *mut u8, layout: Layout) [src]

fn usable_size(&self, layout: &Layout) -> (usize, usize) [src]

unsafe fn realloc( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout) -> Result<*mut u8, AllocErr> [src]

unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> [src]

unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr> [src]

unsafe fn realloc_excess( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout) -> Result<Excess, AllocErr> [src]

unsafe fn grow_in_place( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout) -> Result<(), CannotReallocInPlace> [src]

unsafe fn shrink_in_place( &mut self, ptr: *mut u8, layout: Layout, new_layout: Layout) -> Result<(), CannotReallocInPlace> [src]

fn alloc_one<T>(&mut self) -> Result<Unique<T>, AllocErr> [src]

unsafe fn dealloc_one<T>(&mut self, ptr: Unique<T>) [src]

fn alloc_array<T>(&mut self, n: usize) -> Result<Unique<T>, AllocErr> [src]

unsafe fn realloc_array<T>( &mut self, ptr: Unique<T>, n_old: usize, n_new: usize) -> Result<Unique<T>, AllocErr> [src]

unsafe fn dealloc_array<T>( &mut self, ptr: Unique<T>, n: usize) -> Result<(), AllocErr> [src]

impl Clone for Heap [src]

fn clone(&self) -> Heap [src]

fn clone_from(&mut self, source: &Self) 1.0.0 [src]

impl Copy for Heap [src]