Menu
Search

API Documentation

version 2.106.0

overview

View source code
Display the source code in std/experimental/allocator/building_blocks/scoped_allocator.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Struct std.experimental.allocator.building_blocks.scoped_allocator.ScopedAllocator

ScopedAllocator delegates all allocation requests to ParentAllocator. When destroyed, the ScopedAllocator object automatically calls deallocate for all memory allocated through its lifetime. (The deallocateAll function is also implemented with the same semantics.)

struct ScopedAllocator(ParentAllocator) ;

deallocate is also supported, which is where most implementation effort and overhead of ScopedAllocator go. If deallocate is not needed, a simpler design combining AllocatorList with Region is recommended.

Fields

NameTypeDescription
parent AllocatorList.AllocatorIf ParentAllocator is stateful, parent is a property giving access to an AffixAllocator!ParentAllocator. Otherwise, parent is an alias for AffixAllocator!ParentAllocator.instance.

Methods

NameDescription
allocate (n) Allocates memory. For management it actually allocates extra memory from the parent.
deallocate (b) Deallocates b.
deallocateAll () Deallocates all memory allocated.
empty () Returns Ternary.yes if this allocator is not responsible for any memory, Ternary.no otherwise. (Never returns Ternary.unknown.)
expand (b, delta) Forwards to parent.expand(b, delta).
goodAllocSize (n) Forwards to parent.goodAllocSize (which accounts for the management overhead).
owns (b) Forwards to parent.owns(b).
reallocate (b, s) Reallocates b to new size s.

Example

import std.experimental.allocator.mallocator : Mallocator;
import std.typecons : Ternary;
ScopedAllocator!Mallocator alloc;
writeln(alloc.empty); // Ternary.yes
const b = alloc.allocate(10);
writeln(b.length); // 10
writeln(alloc.empty); // Ternary.no

Authors

License