Memory Rt¶

1

import "std/runtime/memory_rt";

Functions¶

sAlloc¶

1

public f<Result<heap byte*>> sAlloc(unsigned long size)

Allocates a new block of memory of the given size.

Parameters

Returns: Result<heap byte*> — A pointer to the allocated block, or an error if the allocation failed.

sAllocUnsafe¶

1

public f<heap byte*> sAllocUnsafe(unsigned long size)

Allocates a new block of memory of the given size. This panics in case of an out of memory situation.

Parameters

Returns: heap byte* — A pointer to the allocated block

sRealloc¶

1

public f<Result<heap byte*>> sRealloc(heap byte* ptr, unsigned long size)

Reallocates a block of memory to the given size. Subsequently moves the data from the old memory space to the new one.

Parameters

Returns: Result<heap byte*> — A pointer to the reallocated block, or an error if the reallocation failed.

sReallocUnsafe¶

1

public f<heap byte*> sReallocUnsafe(heap byte* ptr, unsigned long size)

Reallocates a block of memory to the given size. Subsequently moves the data from the old memory space to the new one. This panics in case of invalid input or an out of memory situation.

Parameters

Returns: heap byte* — A pointer to the reallocated block, or an error if the reallocation failed.

sCopy¶

1

public f<Result<byte*>> sCopy(heap byte* oldPtr, heap byte* newPtr, unsigned long size)

Copies a block of memory to a new block of memory.

Parameters

Returns: Result<byte*> — A non-owning pointer to the copied block, or an error if the copy failed. The destination block keeps belonging to the caller, so the returned pointer is deliberately not heap-qualified - a Result would free the caller's block as soon as it goes out of scope.

sCopyUnsafe¶

1

public f<heap byte*> sCopyUnsafe(heap byte* oldPtr, heap byte* newPtr, unsigned long size)

Copies a block of memory to a new block of memory.

Parameters

Returns: heap byte* — A pointer to the copied block, or an error if the copy failed.

sMove¶

1

public inline f<heap T*> sMove<T>(heap T*& oldPtr)

Moves the ownership of a heap pointer from oldPtr to the return value. After this operation, oldPtr is set to nil to prevent double frees.

Parameters

Returns: heap T* — The moved pointer

sDestruct¶

1

public p sDestruct<T>(T& obj)

Destroys the given object by calling its dtor if available

Parameters

sDealloc¶

1

public p sDealloc(heap byte*& ptr)

Frees a block of memory. The pointer is zeroed out after freeing the memory to prevent accidental double frees.

Parameters

sDelete¶

1

public p sDelete<T>(heap T*& ptr)

Destroys the given heap-allocated instance and frees the memory.

Parameters

sCompare¶

1

public f<bool> sCompare<T>(const heap T* a, const heap T* b, unsigned long size)

Compares the memory behind pointer A and pointer B for equality.

Parameters

Returns: bool — Is memory equal