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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

[project]
site_name = "rtb-error"
site_description = "Error types and the diagnostic report pipeline: canonical Error enum, Result alias, and the miette hook pipeline."
site_author = "Matt Cockayne"
site_url = "https://error.rust.phpboyscout.uk"
repo_url = "https://gitlab.com/phpboyscout/rust/error"
copyright = """
Copyright © 2026 Matt Cockayne
"""

[project.theme]
logo = "images/branding/logo_transparent.svg"
favicon = "images/branding/favicon.svg"
language = "en"
features = [
    "content.code.copy",
    "navigation.footer",
    "navigation.indexes",
    "navigation.sections",
    "search.highlight",
    "search.suggest",
    "toc.follow",
]

[[project.nav]]
"Overview" = "index.md"

[[project.nav]]
"Tutorials" = [
    { "Tutorials" = "tutorials/index.md" },
    { "Give your CLI a diagnostic error path" = "tutorials/01-give-your-cli-a-diagnostic-error-path.md" },
]

[[project.nav]]
"How-to guides" = [
    { "How-to guides" = "how-to/index.md" },
    { "Install the diagnostic pipeline" = "how-to/01-install-the-diagnostic-pipeline.md" },
    { "Define your own error type" = "how-to/02-define-your-own-error-type.md" },
    { "Set the process exit code" = "how-to/03-set-the-process-exit-code.md" },
    { "Add a support footer" = "how-to/04-add-a-support-footer.md" },
]

[[project.nav]]
"Reference" = [
    { "Reference" = "reference/index.md" },
    { "Crate surface" = "reference/01-crate-surface.md" },
    { "Error and Result" = "reference/02-error-and-result.md" },
    { "hook module" = "reference/03-hook.md" },
    { "exit_code module" = "reference/04-exit-code.md" },
]

[[project.nav]]
"Explanation" = [
    { "Explanation" = "explanation/index.md" },
    { "Errors are values, not handled events" = "explanation/01-errors-are-values.md" },
    { "Why the hook is installed once" = "explanation/02-why-the-hook-is-installed-once.md" },
    { "What rtb-error does not do" = "explanation/03-what-this-does-not-do.md" },
]

[[project.nav]]
"About" = [
    { "Branding" = "about/branding.md" },
]

[[project.nav]]
"API reference (docs.rs)" = "https://docs.rs/rtb-error"

[[project.extra.social]]
icon = "fontawesome/brands/gitlab"
link = "https://gitlab.com/phpboyscout/rust/error"

[[project.extra.social]]
icon = "fontawesome/solid/globe"
link = "https://phpboyscout.uk"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/phpboyscout"

[[project.extra.social]]
icon = "fontawesome/brands/dev"
link = "https://dev.to/phpboyscout"

[[project.extra.social]]
icon = "fontawesome/brands/instagram"
link = "https://www.instagram.com/matt.cockayne/"

[[project.extra.social]]
icon = "fontawesome/brands/tiktok"
link = "https://www.tiktok.com/@phpboyscout"

[[project.extra.social]]
icon = "fontawesome/brands/youtube"
link = "https://www.youtube.com/@phpboyscout"

[[project.extra.social]]
icon = "fontawesome/brands/linkedin"
link = "https://www.linkedin.com/in/matthewcockayne/"

[[project.extra.social]]
icon = "fontawesome/brands/discord"
link = "https://discord.gg/mQzGbmGyzZ"

[[project.extra.social]]
icon = "fontawesome/solid/book"
link = "https://phpboyscout.uk/topics/rust/"
name = "Rust, and what survived the port — the guide on the blog"