memterface 1.1.0

Memterface

Official git repository

A generic allocator API for templated code. Intended to supersede std.experimental.allocator.

If there are any allocator designs you would like to see in memterface.allocator.*, or you need a new API extension to make your allocator more awesome, then please open an issue!

Overview

Memterface provides strong guarantees to the programmer about how its allocators must behave:

• Allocators must always have a deallocate function, and an isOwnerOf function to check whether a slice belongs to the allocator and is valid.
• To reduce manual error-handling and ambiguity, allocate can only return null for zero-sized allocations. When an allocator cannot allocate enough memory, it must throw an error.

A simple Memterface allocator looks something like this:

struct MyAllocator{
	void[] allocate(size_t size) nothrow
	out(memory; memory.length == size)
	out(memory; (size == 0 && memory is null) || isOwnerOf(memory)){
		//return `size` bytes of allocated memory
	}
	
	void deallocate(void[] memory) nothrow
	in(isOwnerOf(memory)){
		//deallocate `memory`
	}
	
	bool isOwnerOf(void[] memory) nothrow{
		//return `true` if this allocator owns `memory`
	}
}

An allocator's functions may be static if they do not rely on any instance data, or an allocator can be implemented using polymorphism via the AllocatorInterface interface.

Extensions

Extensions to the base allocator interface are available for allocators with different needs & features:

Documentation

For more information, inline documentation is available in the library's source code: