space_alloc 0.1.1

General purpose space allocators
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! General purpose space allocators.
//! These don't actually allocate any memory, they only provide bookkeeping. Allocation methods will
//! return [Allocation]s with an offset and size that the user can interpret in whichever way they
//! need.

pub mod align;
mod buddy;

use std::num::NonZeroU64;

pub use buddy::{BuddyAllocation, BuddyAllocator};

pub mod linear;

pub use linear::LinearAllocator;

use thiserror::Error;

pub trait Allocation {
    fn offset(&self) -> u64;
    fn size(&self) -> u64;
}

#[derive(Error, Debug)]
#[error("OOM")]
pub struct OutOfMemory;

pub trait Allocator {
    type Allocation: Allocation;

    fn allocate(
        &mut self,
        size: NonZeroU64,
        alignment: NonZeroU64,
    ) -> Result<Self::Allocation, OutOfMemory>;

    fn from_properties(min_alloc: u64, capacity: NonZeroU64) -> Self;
}

pub trait Deallocator: Allocator {
    fn deallocate(&mut self, alloc: &Self::Allocation);
}