DoxigAlpha
std › array_hash_map › Allocator › realloc

realloc

This function requests a new size for an existing allocation, which can be larger, smaller, or the same size as the old memory allocation. The result is an array of new_n items of the same type as the existing allocation.

If new_n is 0, this is the same as free and it always succeeds.

old_mem may have length zero, which makes a new allocation.

This function only fails on out-of-memory conditions, unlike:

  • remap which returns null when the Allocator implementation cannot do the realloc more efficiently than the caller
  • resize which returns false when the Allocator implementation cannot change the size without relocating the allocation.

Function parameters

Parameters

#
old_mem:anytype
new_n:usize

Type definitions in this namespace

Types

#

Functions in this namespace

Functions

#
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
allocSentinel
Allocates an array of `n + 1` items of type `T` and sets the first `n`
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
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

#

Source

Implementation

#
pub fn realloc(self: Allocator, old_mem: anytype, new_n: usize) t: {
    const Slice = @typeInfo(@TypeOf(old_mem)).pointer;
    break :t Error![]align(Slice.alignment) Slice.child;
} {
    return self.reallocAdvanced(old_mem, new_n, @returnAddress());
}