Skip to main content

BoGlobalAllocator

Struct BoGlobalAllocator 

Source
pub struct BoGlobalAllocator { /* private fields */ }
Expand description

A stable GlobalAlloc adapter for using bomalloc as Rust’s process allocator.

The adapter is const-constructible and lazily creates its BoAllocator, so it can be installed directly on a static:

use bomalloc::BoGlobalAllocator;

#[global_allocator]
static GLOBAL: BoGlobalAllocator = BoGlobalAllocator::new();

fn main() {
    let values = vec![1_u64, 2, 3];
    assert_eq!(values.iter().sum::<u64>(), 6);
}

Allocations made recursively while bomalloc is initializing or managing its own metadata use System. Deallocation routes such pointers back to System by checking whether the address belongs to a bomalloc reservation. If the configured allocator cannot initialize, this adapter remains usable by falling back to System; Self::initialize exposes the initialization error.

Rust’s Allocator trait is still unstable on the crate’s Rust 1.86 baseline; GlobalAlloc is the stable interface for replacing Rust’s global allocator.

Implementations§

Source§

impl BoGlobalAllocator

Source

pub const fn new() -> Self

Creates a lazily initialized global allocator with Config::new.

Source

pub const fn with_config(config: Config) -> Self

Creates a lazily initialized global allocator with a custom configuration.

Source

pub fn initialize(&self) -> Result<(), BoAllocError>

Initializes the process allocator, if necessary.

Source

pub fn stats(&self) -> Result<StatsSnapshot, BoAllocError>

Returns a synchronized snapshot of the installed allocator’s statistics.

Source

pub fn trim(&self, mode: TrimMode) -> Result<TrimStats, BoAllocError>

Cooperatively trims the installed allocator.

Source

pub fn validate(&self) -> Result<(), InvariantError>

Validates the installed allocator’s debug invariants.

Trait Implementations§

Source§

impl Default for BoGlobalAllocator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl GlobalAlloc for BoGlobalAllocator

Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

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

unsafe fn dealloc(&self, pointer: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
Source§

unsafe fn realloc( &self, pointer: *mut u8, layout: Layout, new_size: usize, ) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.