uce/site/doc/pages/unit_info.txt
2026-06-16 23:02:45 +00:00

26 lines
1008 B
Plaintext

:sig
DValue unit_info(String path = "")
:params
path : optional UCE unit path. If empty, uses the current executing unit.
return value : metadata tree for the resolved unit, or an empty tree if the unit cannot be resolved
:see
>runtime
units_list
unit_compile
0_Request
:content
Returns runtime metadata for a UCE compilation unit.
The returned tree is supplied by the host runtime and may include normalized source/artifact paths, compile/runtime status, ABI/wasm availability, timing counters, mtimes, and exported API declarations. Treat absent fields as unavailable rather than as false.
If `path` is relative, it is resolved by the same host unit resolver used for unit calls/components.
Because unit metadata lives in worker process memory, request and timing counters reflect the current runtime process, not an aggregate across every worker process.
:example
DValue info = unit_info("examples/sample_unit.uce");
print("unit_info() returns ", info.get_type_name(), " metadata for the unit\n");