diff options
author | Paul Fenwick <pjf@perltraining.com.au> | 2018-08-12 21:43:54 +1000 |
---|---|---|
committer | Paul Fenwick <pjf@perltraining.com.au> | 2018-08-12 21:43:54 +1000 |
commit | 5320d55be62d55a2a2be5458e46b9352cd70edf0 (patch) | |
tree | 3a9578e2f5d4f624fde2a34b69de73e18c444fd1 /README.md | |
parent | f92e4df1f9894a63d0eadcd127fcf023aac5e72b (diff) |
README: Document set_titles, use prettyformat::table, plus extra tests!
README:
- Mention `set_titles()`
- Explicitly `use prettytable::format`
- Expand sample code to call `set_titles()` and `add_row()`s.
lib.rs:
- Added test from README code using the longhand FormatBuilder
- Added test from README using FORMAT_NO_LINESEP_WITH_TITLE
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 10 insertions, 1 deletions
@@ -269,13 +269,14 @@ Configurable settings include: - Junctions
- Column separators
- Line separators
+- Titles (using `table.set_titles()`)
To do this, either:
- create a new `TableFormat` object, then call setters until you get the desired configuration;
- or use the convenient `FormatBuilder` and Builder pattern, shown below
```rust
-let mut table = /* Initialize table */;
+let mut table = Table::new();
let format = format::FormatBuilder::new()
.column_separator('|')
.borders('|')
@@ -285,6 +286,10 @@ let format = format::FormatBuilder::new() .padding(1, 1)
.build();
table.set_format(format);
+
+table.set_titles(row!["Title 1", "Title 2"]);
+table.add_row(row!["Value 1", "Value 2"]);
+table.add_row(row!["Value three", "Value four"]);
```
The code above will make the table look like
@@ -300,6 +305,8 @@ For convenience, several formats are predefined in `prettytable::format::consts` Some formats and their respective outputs:
- ```rust
+ use prettytable::format;
+
table.set_format(*format::consts::FORMAT_NO_LINESEP_WITH_TITLE);
```
```
@@ -311,6 +318,8 @@ Some formats and their respective outputs: +-------------+------------+
```
- ```rust
+ use prettytable::format;
+
table.set_format(*format::consts::FORMAT_NO_BORDER_LINE_SEPARATOR);
```
```
|