Module settings

Source

Functions§

export_kv 🔒
Utility: retrieve (export) settings as Vec<String> (kv array form).
get_enabled_variants_for_format
Get enabled variants for a format/direction. Splits the setting “variants” value (space-delimited).
get_exec_option
Get execution option (JS getExecOption) – returns empty string if not present.
get_exec_options
Get full execution options array (kv flattened array form).
get_export_settings
Internal: get current export settings string for a format id.
get_format_export_setting
Get a single export setting (empty string if not set).
get_format_export_settings
Entire export settings (kv array form).
get_format_import_setting
Get a single import setting (empty string if not set).
get_format_import_settings
Entire import settings (kv array form).
get_import_settings
Internal: get current import settings string for a format id.
get_preferred_code_language_for_format
Preferred code language for a format/direction. Defaults to env_code_language and scans for variants of the form “pl_<lang>”. Returns just the <lang> portion if found.
get_preferred_language_for_format
Preferred language (variant) for a format/direction. Defaults to the environment language (state.env_language) and scans the variant list for entries beginning with “lang_”.
get_setting_for_format
Return the value string for a single setting key, or “” if not present.
get_settings_for_format
Returns a flat array of key/value pairs for a format’s settings (direction “in” for import or anything else for export).
has_import_setting
Check whether a named key exists in format (import/export) settings. (JS implIn equivalent for import direction).
import_kv 🔒
Utility: retrieve (import) settings as Vec<String> (kv array form).
pop_export_settings
Pop (restore) last deferred export settings for the given format id.
pop_format_export_setting
Restore an export setting.
pop_format_import_setting
Restore an import setting to provided previous value.
pop_import_settings
Pop (restore) last deferred import settings for the given format id.
push_export_settings
Push (defer) current export settings for given format id, then replace.
push_format_export_setting
Temporarily set an export setting; returns previous value.
push_format_import_setting
Temporarily set an import setting; returns previous value (empty string if unset).
push_import_settings
Push (defer) current import settings for given format id onto a shared stack, then replace with the provided new setting string.
set_exec_option
Set an execution option.
set_export_kv 🔒
Replace export settings for a format with a kv array.
set_export_settings 🔒
Set the export settings string at a given format id, resizing vector as needed.
set_format_export_setting
Set a single export setting (adds if missing).
set_format_export_settings
Replace entire export settings (kv array form).
set_format_import_setting
Set a single import setting (adds if missing).
set_format_import_settings
Replace entire import settings (kv array form).
set_import_kv 🔒
Replace import settings for a format with a kv array.
set_import_settings 🔒
Set the import settings string at a given format id, resizing vector as needed.
setting_array_to_string
Converts an even-length key/value array to a settings string in the format “k1:v1,k2:v2,”. Returns an error if the key is not a valid StageL identifier. This deliberately doesn’t match the JS version, which appears to have had a bug that caused it to format the string as “k1,v1:k2,v2:”.
setting_string_to_array
Parse a format’s setting string into a flat key/value Vec<String>.