NativeStringAlloc class final

A specialised slot-based allocator for C strings (Pointer\<Char>).

Maintains two separate pools:

  • Anonymous slots – a ring buffer of slotCount slots, cycled through via Value without a key. Useful for transient strings within a single callsite.
  • Keyed slots – named slots allocated on demand via ValueAt and Array, persisting until explicitly freed or _dispose is called.

String memory is managed with malloc and is grown in-place when the encoded UTF-8 length of a new string exceeds the current slot capacity, avoiding unnecessary reallocations for strings of similar length.

Inheritance
Mixed-in types

Constructors

NativeStringAlloc(RaylibTemp temp, String name, {required int slotCount, required Pointer<Char> allocatorFunc([int count])})

Properties

allocatorFunc → Pointer<Char> Function([int count])
Allocates count elements and returns the raw source pointer.
finalinherited
byteSize → int
Size in bytes of a single element this allocator manages.
finalinherited
freeFunc → void Function(Pointer<Char> ptr)
Frees the memory at ptr.
finalinherited
freePPFunc ↔ void Function(Pointer<Pointer<Char>> ptr)
latefinaloverride-getter
hashCode → int
The hash code for this object.
no setterinherited
indexSetterFunc ↔ void Function(Pointer<Pointer<Char>> ptrptr, int i, Pointer<Char> ptr)
latefinaloverride-getter
isPointerNull → bool Function(Pointer<Char> ptr)
Returns true if ptr is null or zero.
finalinherited
name → String
Debug name for this allocator, used in logging and diagnostics.
finalinherited
nullptrFactory → Pointer<Char> Function()
Returns a null/zero pointer of type P.
finalinherited
pointerFactory → Pointer<Char> Function(Pointer<Char> ptr)
Wraps a source pointer ptr into the platform pointer type P.
finalinherited
pointerToSource → Pointer<Char> Function(Pointer<Char> ptr)
Unwraps a platform pointer ptr back to its source type S.
finalinherited
printerFunc → String Function(Pointer<Char> ptr)
Returns a human-readable string representation of ptr.
finalinherited
ptrAllocatorFunc ↔ Pointer<Pointer<Char>> Function(int count)
latefinaloverride-getter
ptrByteSize → int
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slotCount → int
Number of anonymous (ring-buffer) string slots pre-reserved on construction.
final
slots → Map<String, (Pointer<Char>, int)>
Active allocation slots, keyed by slot name. Each entry holds the pointer and its element count.
finalinherited
stringAnonIndex ↔ int
getter/setter pairinherited
stringCapacities ↔ List<int>
getter/setter pairinherited
stringSlots ↔ List<Pointer<Char>>
getter/setter pairinherited
stringSlotsKeyed → Map<String, int>
finalinherited
stringSlotsPtrsKeyed → Map<String, (Pointer<Pointer<Char>>, int)>
finalinherited
temp → RaylibTemp
finalinherited

Methods

Array(List<String> array, {String? key}) → Pointer<Pointer<Char>>
Writes each string in array into keyed sub-slots and returns a tracked PP of length array.length.
inherited
At(String key, [int count = 1]) → Pointer<Char>
Returns the P stored in key, allocating (or reallocating) if necessary.
inherited
AtPtr(String key, [int count = 1]) → Pointer<Pointer<Char>>
inherited
AtUnique(String key, [int count = 1]) → Pointer<Char>
Allocates (or reuses) a slot identified by a unique key suffix.
inherited
dispose() → void
Frees all currently tracked slots and clears the slot table.
inherited
Fill(int count, Pointer<Char> init(int), {String? key}) → Pointer<Pointer<Char>>
Fills a tracked PP of count elements by calling init for each index.
inherited
Free(String key) → void
Frees the native memory owned by slot key and removes it from the table.
inherited
Has(String key) → bool
Returns true if a slot with the given key exists.
inherited
Length(String text, [int? bufferSize]) → int
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
Raw([int count = 1]) → Pointer<Char>
Allocates count raw elements and returns the wrapped pointer.
inherited
reallocSlotIfRequired(int slot, int length) → void
inherited
Ref1([String? o, int? bufferSize]) → Pointer<Char>
Writes o into slot '1' and returns its pointer.
inherited
Ref2([String? o, int? bufferSize]) → Pointer<Char>
Writes o into slot '2' and returns its pointer.
inherited
Ref3([String? o, int? bufferSize]) → Pointer<Char>
Writes o into slot '3' and returns its pointer.
inherited
Ref4([String? o, int? bufferSize]) → Pointer<Char>
Writes o into slot '4' and returns its pointer.
inherited
RefOrNull1(String? o) → Pointer<Char>
Writes o into slot '1' and returns its pointer, or returns nullptr if o is null.
inherited
RefOrNull2(String? o) → Pointer<Char>
Writes o into slot '2' and returns its pointer, or returns nullptr if o is null.
inherited
RefOrNull3(String? o) → Pointer<Char>
Writes o into slot '3' and returns its pointer, or returns nullptr if o is null.
inherited
RefOrNull4(String? o) → Pointer<Char>
Writes o into slot '4' and returns its pointer, or returns nullptr if o is null.
inherited
reset() → void
Resets all slot bookkeeping structures to their initial state.
inherited
signature() → String
Returns a string that identifies the concrete type of this allocator, including its type parameters.
inherited
Size([int count = 1]) → int
Returns the total byte size for count elements.
inherited
Slot(String key) → Pointer<Char>?
Returns the pointer stored under key, or null if the slot does not exist. Does not allocate.
inherited
slotKey([String? key]) → String
Returns the canonical slot key for key, falling back to 'struct' when key is null.
inherited
toString() → String
A string representation of this object.
inherited
uniqueSlotKey(String key) → String
Returns a slot key guaranteed to be unique within this temp context, by prefixing key with the next available ID.
inherited
Unslot(String key) → void
Removes the slot entry for key from the table without freeing the underlying memory.
inherited
Value(String text, [String? key]) → Pointer<Char>
Returns a P for text using the next anonymous ring-buffer slot.
inherited
ValueAt(String key, [String? text, int? bufferSize]) → Pointer<Char>
Returns the P for the keyed slot key, optionally writing text into it.
inherited
ValueOrNull([String? text, String? key]) → Pointer<Char>
Writes text into slot using Value and returns its pointer, or returns nullptr if text is null.
inherited
writeToSlot(int slot, String text, [int? bufferSize]) → Pointer<Char>
Writes text into slot slot, reallocating if the current capacity is insufficient for the UTF-8 encoded length.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited