# Heap in buddy_system_allocator - Rust
A heap that uses buddy system
Keywords: rust, rustlang, rust-lang, Heap

# Struct buddy_system_allocator::Heap

source · [−]

    pub struct Heap { /* private fields */ }

Expand description

A heap that uses buddy system

## Usage

Create a heap and add a memory region to it:

    use buddy_system_allocator::*;
    let mut heap = Heap::empty();
    unsafe {
        heap.init(begin, size);
        // or
        heap.add_to_heap(begin, end);
    }

## Implementations

source

### impl Heap

source

#### pub const fn new() -> Self

Create an empty heap

source

#### pub const fn empty() -> Self

Create an empty heap

source

#### pub unsafe fn add_to_heap(&mut self, start: usize, end: usize)

Add a range of memory [start, end) to the heap

source

#### pub unsafe fn init(&mut self, start: usize, size: usize)

Add a range of memory [start, end) to the heap

source

#### pub fn alloc(&mut self, layout: Layout) -> Result<NonNull<u8>, ()>

Alloc a range of memory from the heap satifying `layout` requirements

source

#### pub fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout)

Dealloc a range of memory from the heap

source

#### pub fn stats_alloc_user(&self) -> usize

Return the number of bytes that user requests

source

#### pub fn stats_alloc_actual(&self) -> usize

Return the number of bytes that are actually allocated

source

#### pub fn stats_total_bytes(&self) -> usize

Return the total number of bytes in the heap

## Trait Implementations

source

### impl Debug for Heap

source

#### fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### impl RefUnwindSafe for Heap

### impl Send for Heap

### impl !Sync for Heap

### impl Unpin for Heap

### impl UnwindSafe for Heap

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.