https://github.com/ivorforce/display-with-options
Display and Debug with options passed around. Indentation functionality.
https://github.com/ivorforce/display-with-options
Last synced: about 1 year ago
JSON representation
Display and Debug with options passed around. Indentation functionality.
- Host: GitHub
- URL: https://github.com/ivorforce/display-with-options
- Owner: Ivorforce
- License: mit
- Created: 2024-04-25T17:41:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T11:37:27.000Z (over 2 years ago)
- Last Synced: 2024-10-30T01:44:20.359Z (over 1 year ago)
- Language: Rust
- Homepage: https://crates.io/crates/display_with_options
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# display_with_options
This tiny (< 200 LOC) crate allows you to pass options around in Display and Debug.
It also adds a way to indent a formatter implicitly on fresh new lines.
Both components are technically separate, but interact in useful ways to provide a customizable
indentation and pretty printing pipeline. In contrast to similar crates, this one gives you full
control while maintaining a close relationship with rust core functionality.
## Usage Examples
### IndentingFormatter
```rust
use display_with_options::IndentingFormatter;
fn main() {
let mut dst: Vec = vec![];
writeln!(dst, "A").unwrap();
let mut f = IndentingFormatter::new(&mut dst, " ");
writeln!(f, "B").unwrap();
}
```
Result:
```
A
B
```
### DisplayWithOptions
```rust
use std::fmt::{Formatter, Write};
use display_with_options::{DisplayWithOptions, IndentingFormatter, IndentOptions, with_options};
/// Tree-like structure
struct Node {
name: String,
children: Vec>
}
impl Node {
pub fn new(name: &str, children: Vec>) -> Box {
Box::new(Node {
name: name.to_string(),
children
})
}
}
impl<'a> DisplayWithOptions> for Node {
fn fmt(&self, f: &mut Formatter, options: &IndentOptions) -> std::fmt::Result {
writeln!(f, "{}{}", options, self.name)?;
let options = options.deeper();
let mut f = IndentingFormatter::new(f, &options.full_indentation);
let options = options.restart();
for child in self.children.iter() {
write!(f, "{}", with_options(child.as_ref(), &options))?;
}
Ok(())
}
}
// Test the Code
fn main() {
let tree = Node::new("A", vec![
Node::new("B", vec![
Node::new("C", vec![]),
]),
Node::new("D", vec![]),
]);
let options = IndentOptions::new(" ");
println!("{}", with_options(tree.as_ref(), &options));
}
```
Result:
```
A
B
C
D
```