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
---
title: How-to guides
description: Task-shaped recipes for installing the diagnostic pipeline, defining error types, setting exit codes and adding a support footer.
tags: [how-to]
---

# How-to guides

Each page solves one task and assumes you already have `rtb-error` in your
`Cargo.toml`. If you are starting from nothing, do the
[tutorial](../tutorials/01-give-your-cli-a-diagnostic-error-path.md) first.

| Page | Task |
|---|---|
| [Install the diagnostic pipeline]01-install-the-diagnostic-pipeline.md | Get graphical diagnostics and panics rendering the same way, in the right order |
| [Define your own error type]02-define-your-own-error-type.md | Write a `Diagnostic` enum for your crate and convert it at the framework boundary |
| [Set the process exit code]03-set-the-process-exit-code.md | Exit with something other than `1` when a specific error occurs |
| [Add a support footer]04-add-a-support-footer.md | Append a support line to every rendered diagnostic, including panics |