Menu
Search

API Documentation

version 2.106.0

overview

View source code
Display the source code in std/experimental/allocator/building_blocks/affix_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.

Function std.experimental.allocator.building_blocks.affix_allocator.AffixAllocator.prefix

Affix access functions offering references to the affixes of a block b previously allocated with this allocator. b may not be null. They are defined if and only if the corresponding affix is not void.

ref auto prefix(T) (
  T[] b
);

The qualifiers of the affix are not always the same as the qualifiers of the argument. This is because the affixes are not part of the data itself, but instead are just associated with the data and known to the allocator. The table below documents the type of preffix(b) and affix(b) depending on the type of b.

Affix is Prefix or Suffix),
Result of prefix/suffix depending on argument (U is any unqualified type, Affix is Prefix or Suffix)
Argument Type Return Comments
shared(U)[] ref shared Affix Data is shared across threads and the affix follows suit.
immutable(U)[] ref shared Affix Although the data is immutable, the allocator "knows" the underlying memory is mutable, so immutable is elided for the affix which is independent from the data itself. However, the result is shared because immutable is implicitly shareable so multiple threads may access and manipulate the affix for the same data.
const(shared(U))[] ref shared Affix The data is always shareable across threads. Even if the data is const, the affix is modifiable by the same reasoning as for immutable.
const(U)[] ref const Affix The input may have originated from U[] or immutable(U)[], so it may be actually shared or not. Returning an unqualified affix may result in race conditions, whereas returning a shared affix may result in inadvertent sharing of mutable thread-local data across multiple threads. So the returned type is conservatively ref const.
U[] ref Affix Unqualified data has unqualified affixes.

Precondition

b !is null and b must have been allocated with this allocator.

Authors

License