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.
What the crate exports¶
Everything public comes out of the crate root. There are no public
submodules beyond the re-exported tabled crate.
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;
| Item | Kind | Page |
|---|---|---|
Wizard<S>, WizardBuilder<S>, WizardStep<S>, StepOutcome |
struct / trait / enum | Wizard |
render_table, render_json |
functions | Render helpers |
Spinner |
struct | Spinner |
WizardError, RenderError |
error enums | Errors |
InquireError |
re-export of inquire::InquireError |
Wizard |
tabled |
re-export of the tabled crate |
Render helpers |
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:
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.
Crate-level facts¶
Version, MSRV, Cargo features, dependency set and lint policy are on Crate metadata.