storageAddress (object -- address)

Inputs

• object: Object whose storage address is queried.

Outputs

• address: Storage address as known or unknown Natx.

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

Behavior

• In-place objects, non-NIL Ref objects, non-NIL Code objects, and non-NIL Text objects 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 objects produce the known zero address 0nx.
• Taking the address of a known non-NIL Ref destabilizes its referenced target, including through an immutable view.
• Meta objects are invalid.

Example

{} () {} [
  value: 7;
  text: "hello";
  code: {} () {} codeRef;

  "-- immutable and mutable Ref views --" printCompilerMessage
  value storageAddress printStack _:;
  @value storageAddress printStack _:;

  "-- text and known NIL cases --" printCompilerMessage
  text storageAddress printStack _:;
  0nx value addressToReference storageAddress printStack _:; # a NIL Ref
  @code storageAddress printStack _:;
] "main" exportFunction

Expected Output During Compilation

-- immutable and mutable Ref views --
Natx
Natx
-- text and known NIL cases --
Natx
0nx
0nx

See also

• addressToReference builtin (address modelValue -- reconstructedValue) Typed reconstruction from a numeric storage address. Ref-like model objects keep their schema, and direct non-Ref-like model objects produce Ref results.
• alignment builtin (schema -- alignment) Known Natx alignment requirement of the dereferenced schema.
• manuallyDestroyVariable builtin (object --) Manually destroys the designated object in place without freeing the storage.
• manuallyInitVariable builtin (object --) Manually initializes the designated object in existing storage without allocating the storage.
• storageSize builtin (schema -- size) Known Natx storage size of the dereferenced schema.