Skip to content

Reference

Lookup-oriented pages: signatures, defaults, failure conditions. Read these when you know what you are looking for and want the exact behaviour.

  • API reference — every public type and method, its signature, its trait bounds, and what it does when the input is wrong.
  • Error reference — every ConfigError variant, its miette diagnostic code, and the exact conditions that produce it.
  • Cargo features and dependencieshot-reload and mutable, what each adds, and the crate's MSRV.

Generated rustdoc for the same surface is on docs.rs/rtb-config. The pages here add the behaviour that a signature does not show: merge order, which failures are silent, and what each error actually means.

Where to look for a given question

Question Page
What does this method return, and when does it fail? API reference
Which layer wins when two of them set the same key? API reference
What does this error message mean? Error reference
Which feature do I need for watch_files / write? Cargo features
Why is my environment variable being ignored? Limitations