allocSentinel

Allocates an array of n + 1 items of type T and sets the first n items to undefined and the last item to sentinel. Depending on the Allocator implementation, it may be required to call free once the memory is no longer needed, to avoid a resource leak. If the Allocator implementation is unknown, then correct code will call free when done.

For allocating a single item, see create.

Function parameters

Parameters

self:Allocator
Elem:type
n:usize
sentinel:Elem

Type definitions in this namespace

Types

VTable

Functions in this namespace

Functions

noResize
noRemap
noFree
rawAlloc: This function is not intended to be called except from within the
rawResize: This function is not intended to be called except from within the
rawRemap: This function is not intended to be called except from within the
rawFree: This function is not intended to be called except from within the
create: Returns a pointer to undefined memory.
destroy: `ptr` should be the return value of `create`, or otherwise
alloc: Allocates an array of `n` items of type `T` and sets all the
allocWithOptions
allocWithOptionsRetAddr
allocSentinel: Allocates an array of `n + 1` items of type `T` and sets the first `n`
alignedAlloc
allocAdvancedWithRetAddr
resize: Request to modify the size of an allocation.
remap: Request to modify the size of an allocation, allowing relocation.
realloc: This function requests a new size for an existing allocation, which
reallocAdvanced
free: Free an array allocated with `alloc`.
dupe: Copies `m` to newly allocated memory.
dupeZ: Copies `m` to newly allocated memory, with a null-terminated element.

Error sets in this namespace

Error Sets

Error

Source

Implementation

pub fn allocSentinel(
    self: Allocator,
    comptime Elem: type,
    n: usize,
    comptime sentinel: Elem,
) Error![:sentinel]Elem {
    return self.allocWithOptionsRetAddr(Elem, n, null, sentinel, @returnAddress());
}