facet_pretty/lib.rs
1#![warn(missing_docs)]
2#![warn(clippy::std_instead_of_core)]
3#![warn(clippy::std_instead_of_alloc)]
4//!
5//! [](https://coveralls.io/github/facet-rs/facet?branch=main)
6//! [](https://crates.io/crates/facet-pretty)
7//! [](https://docs.rs/facet-pretty)
8//! [](./LICENSE)
9//! [](https://discord.gg/JhD7CwCJ8F)
10//!
11//! Provides pretty-printing capabilities for Facet types.
12//!
13//! Example:
14//!
15//! ```rust
16//! use facet::Facet;
17//! use facet_pretty::FacetPretty;
18//!
19//! #[derive(Debug, Facet)]
20//! struct Person {
21//! name: String,
22//! age: u32,
23//! }
24//!
25//! let person = Person {
26//! name: "Alice".to_string(),
27//! age: 30,
28//! };
29//! println!("Default pretty-printing:");
30//! println!("{}", person.pretty());
31//! ```
32//!
33//! Produces the output:
34//!
35//! ```text
36//! Person {
37//! name: "Alice",
38//! age: 30,
39//! }
40//! ```
41#![doc = include_str!("../readme-footer.md")]
42
43extern crate alloc;
44
45mod color;
46mod display;
47mod printer;
48mod shape;
49
50pub use color::*;
51pub use display::*;
52pub use printer::*;
53pub use shape::*;