---
title: Reference
description: Signatures, defaults, panics and error variants for every public item in rtb-tui.
tags: [reference]
---
# Reference
Exact behaviour of every public item in `rtb-tui`, with the defaults and
failure modes spelled out. If you want to know what something *does*,
this is the tier. If you want to know *why* it does that, read
[Explanation](../explanation/index.md).
## What the crate exports
Everything public comes out of the crate root. There are no public
submodules beyond the re-exported `tabled` crate.
```rust
pub use error::{RenderError, WizardError};
pub use render::{render_json, render_table};
pub use spinner::Spinner;
pub use wizard::{StepOutcome, Wizard, WizardBuilder, WizardStep};
pub use inquire::InquireError;
pub use tabled;
```
| `Wizard<S>`, `WizardBuilder<S>`, `WizardStep<S>`, `StepOutcome` | struct / trait / enum | [Wizard](01-wizard.md) |
| `render_table`, `render_json` | functions | [Render helpers](02-render-helpers.md) |
| `Spinner` | struct | [Spinner](03-spinner.md) |
| `WizardError`, `RenderError` | error enums | [Errors](04-errors.md) |
| `InquireError` | re-export of `inquire::InquireError` | [Wizard](01-wizard.md#inquireerror-re-export) |
| `tabled` | re-export of the `tabled` crate | [Render helpers](02-render-helpers.md#which-tabled-to-derive) |
## Where the generated API docs are
This tier documents behaviour: defaults, panics, what happens when an
input is wrong. The generated signature-by-signature API listing is on
docs.rs and is built from the same source:
- <https://docs.rs/rtb-tui>
Both are checked against the code. If you find a place where they
disagree, the code decides, and the disagreement is a bug worth
[raising](https://gitlab.com/phpboyscout/rust/tui/-/issues).
## Crate-level facts
Version, MSRV, Cargo features, dependency set and lint policy are on
[Crate metadata](05-crate.md).