Name

inspect — Introspection command for Rivet configuration

Synopsis

inspect ?configuration_section? ?configuration_parameter?

Description

::rivet::inspect provides introspection into the running configuration of Rivet. Rivet's debug command uses it in order to gain insight into the configuration, but it can be used in any script.

::rivet::inspect can be called in three forms

  • Passing as argument the switch ?-all? a dictionary carrying the whole configuration is returned
  • With one argument (one of the Rivet configuration directives) ::rivet::inspect returns the current value in the configuration record
  • With no argument the command returns a dictionary with 3 keys: server, dir, user. Each key is associated to a subdictionary carrying the configuration lines actually set. Configuration directives are the keys in the second level dictionary. In this form the command is meant to provide a way to create global arrays RivetServerConf, RivetDirConf and RivetUserConf which are internally used by ::rivet::debug