Skip to main content

declared_params

Function declared_params 

Source
pub fn declared_params(reference: &str) -> Option<HashMap<String, String>>
Expand description

A workload reference’s declared top-level params: (string scalars), following its extends: chain — resolved the way nmbrs run resolves workload=…. Returns None if the reference resolves to nothing or has no params: block.

The canonical “what params did the workload declare” accessor. The runner folds these under the CLI params (CLI wins) to form the run’s effective params, so a setting works identically whether declared in the workload or passed on the command line. Also used to recognize a console-owning adapter declared in the workload (e.g. params: { adapter: plotter }) so the dashboard yields to the adapter on a TTY (SRD-41/87); the returned params carry the adapter’s display-shaping keys (e.g. stdout’s filename) so the preference is decided correctly.