storageAddress (value -- address)

Builtins

Name introduction, declaration modifiers, and module binding: NAME: ...;, codeRef, def, exportFunction, importFunction, importVariable, overload, private, static, use, and virtual.
Struct construction forms: (...), {...}, and array.
Selection forms: source-text selection with NAME and .NAME, read-only source-text selection with @NAME and .@NAME, and ordinal or known-name data-input selection with @, callField, and fieldRead.
Writing forms: source-text selection with !NAME and .!NAME, ordinal selection with ! and fieldWrite, and already-selected destination replacement with set.
Calling and control flow: call, if, loop, ucall, and uif.
Text operations: &, LF, attribute, textSize, and textSplit.
Condition constants, value comparison, and logical operators: <, =, >, DEBUG, FALSE, TRUE, and, is, lshift, or, rshift, xor, and ~.
Arithmetic and numeric transforms: *, +, -, /, ^, cast, ceil, cos, floor, log, log10, mod, neg, sin, and sqrt.
Reference, creation, and value-state operations: const, dynamic, isConst, isDirty, isDynamic, isRef, isStatic, known?, new, newVarOfTheSameType, stable?, unconst, and unknownStable?.
Schema and struct introspection: code?, codeRef?, fieldCount, fieldIndex, fieldIsRef, fieldIsVirtual, fieldName, has, isCombined, managed?, same, schemaName, and virtual?.
Storage and manual lifetime operations: addressToReference, alignment, manuallyDestroyVariable, manuallyInitVariable, storageAddress, and storageSize.
Diagnostics and compile-time failure: failCompilation, getCallTrace, printCompilerMessage, printStack, printStackTrace, and raiseStaticError.

storageAddress (value -- address)

Inputs

value: Value whose storage address is queried.

Outputs

address: Storage address as known or unknown Natx.

storageAddress is a current stack-value storage query. It returns the storage address of one non-Meta value as known or unknown Natx. The result depends on the current stack value, including known nilness.

Behavior

In-place values, non-NIL Ref values, non-NIL Code values, and non-NIL Text values produce an unknown Natx result.

For non-NIL Text, the reported address is the address of the referenced UTF-8 storage.

Known NIL Ref, Text, and Code values produce the known zero address 0nx.

Meta values are invalid.

Example

{} () {} [ value: 7; text: "hello"; code: {} () {} codeRef; "-- In-place value and Ref --" printCompilerMessage value storageAddress printStack _:; @value storageAddress printStack _:; "-- text and known NIL cases --" printCompilerMessage text storageAddress printStack _:; 0nx value addressToReference storageAddress printStack _:; @code storageAddress printStack _:; ] "main" exportFunction

Expected Output During Compilation

-- In-place value and Ref -- Natx Natx -- text and known NIL cases -- Natx 0nx 0nx