rtb-error 0.6.5

Error types and the diagnostic report pipeline. Part of the phpboyscout Rust toolkit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

---
title: Reference
description: The complete public surface of rtb-error (every type, function, diagnostic code and default) and what happens when each is used wrongly.
tags: [reference]
---

# Reference

The complete public surface of `rtb-error` as of 0.6.4, with defaults and
failure behaviour stated for each item. Signatures here are copied from the crate
source, not paraphrased.

| Page | Answers |
|---|---|
| [Crate surface](01-crate-surface.md) | What does `rtb_error::*` export? What is the MSRV? Which Cargo features exist? |
| [`Error` and `Result`](02-error-and-result.md) | What are the variants, their diagnostic codes, their help text, and what converts into them? |
| [`hook` module](03-hook.md) | What do the three `install_*` functions do, in what order must they be called, and what changes about rendering? |
| [`exit_code` module](04-exit-code.md) | How does an error carry a process exit code, and when does that code survive? |

The generated API documentation, with every signature and every trait
implementation, is on [docs.rs/rtb-error](https://docs.rs/rtb-error). These
pages cover the things a signature does not tell you: defaults, ordering
requirements, and what goes wrong.