Skip to main content

Module tool

Module tool 

Source
Expand description

The program every file and document FusionSpace HPR writes names, as a drawing’s title block names the tool that made it: its name, its version and its designation in the FusionSpace product system (ADR-164, which adopts that system; its data.md: “Every export carries the designation and version of the tool that made it”).

The writers put these three in whatever place their format keeps for it: a .eng file’s comment, an XML comment or attribute, a JSON object, Parquet’s key-value metadata.

Constants§

DESIGNATION
Its designation in the FusionSpace product system, <code> · <tag> · <kind> <number> in the system’s grammar: the simulator’s internal name, Achernar (FS-ACHERNAR, a star of project Eridanus), then software tool 1 (ADR-198 §4).
EARLIER_DESIGNATIONS
The designations earlier builds wrote, which readers still recognize: FS · SW · TOOL 005, written by every build from the command line’s restyle until ADR-198 retired it. Nothing writes these.
EARLIER_NAME
The name earlier builds wrote, which readers still recognize: hpr-sim, written by every build until ADR-199, the public name, renamed the program, with either designation (builds after ADR-198, project Eridanus, wrote the new designation under the old name). Nothing writes it.
NAME
The program’s name: FusionSpace HPR, the suite’s public name (ADR-199 §4).
VERSION
Its version, the workspace’s: 0.1.0 until the first release changes it.

Functions§

is_stamp
Whether text is a stamp this program wrote, at this version or any other: a name, a space, and a version (starting with a digit, as every Cargo version does), then · and a designation at the end. Surrounding white space is ignored. The pairs recognized are the ones some build wrote: NAME with DESIGNATION, and EARLIER_NAME with DESIGNATION or an earlier designation.
stamp
The three on one line, FusionSpace HPR 0.1.0 · FS-ACHERNAR · SW · TOOL 001, for a format that keeps one line of text for it: the external name first, as the system’s naming rule asks.