SharedBorrowedRegion

A SharedBorrowedRegion allocates directly from a user-provided block of memory.

Unlike a SharedRegion, a SharedBorrowedRegion does not own the memory it allocates from and will not deallocate that memory upon destruction. Instead, it is the user's responsibility to ensure that the memory is properly disposed of.

In all other respects, a SharedBorrowedRegion behaves exactly like a SharedRegion.

shared

struct SharedBorrowedRegion (

uint minAlign = platformAlignment

Flag!"growDownwards" growDownwards = No.growDownwards

) {

struct Ternary via import std.typecons : Ternary;;

this(ubyte[] store);

size_t goodAllocSize(size_t n);

alias alignment = minAlign;

void[] allocate(size_t n);

void[] alignedAllocate(size_t n, uint a);

bool deallocate(void[] b);

bool deallocateAll();

Ternary owns(void[] b);

Ternary empty();

}

Constructors

this this(ubyte[] store): Constructs a region backed by a user-provided store.

Members

Aliases

alignment alias alignment = minAlign: Alignment offered.

Functions

alignedAllocate void[] alignedAllocate(size_t n, uint a): Allocates n bytes of memory aligned at alignment a.
allocate void[] allocate(size_t n): Allocates n bytes of memory. The allocation is served by atomically incrementing a pointer which keeps track of the current used space.
deallocate bool deallocate(void[] b): Deallocates b. This works only if b was obtained as the last call to allocate; otherwise (i.e. another allocation has occurred since) it does nothing.
deallocateAll bool deallocateAll(): Deallocates all memory allocated by this region, which can be subsequently reused for new allocations.
empty Ternary empty(): Returns Ternary.yes if no memory has been allocated in this region, Ternary.no otherwise. (Never returns Ternary.unknown.)
goodAllocSize size_t goodAllocSize(size_t n): Rounds the given size to a multiple of the alignment
owns Ternary owns(void[] b): Queries whether b has been allocated with this region.

SharedBorrowedRegion

Constructors

Members

Aliases

Functions

Meta

Source