Skip to main content

Module example

Module example 

Source
Expand description

Reads an annotated example configuration, commented settings included.

An application ships one example that documents every TOML setting, with optional ones commented out. Its tests use this to check that the example names every schema option and that every documented value, active or commented, still parses — so the file an operator copies cannot drift from the binary that reads it.

Structs§

AnnotatedExample
Every setting the example mentions, merged into one document.

Enums§

ExampleError

Functions§

contains
Whether a dotted path exists in document.
set
Inserts value at a dotted path, creating intermediate tables.