Struct prettytable::format::TableFormat
source · pub struct TableFormat { /* private fields */ }
Expand description
Contains the table formatting rules
Implementations§
source§impl TableFormat
impl TableFormat
sourcepub fn new() -> TableFormat
pub fn new() -> TableFormat
Create a new empty TableFormat.
sourcepub fn get_padding(&self) -> (usize, usize)
pub fn get_padding(&self) -> (usize, usize)
Return a tuple with left and right padding
sourcepub fn padding(&mut self, left: usize, right: usize)
pub fn padding(&mut self, left: usize, right: usize)
Set left and right padding
Examples found in repository?
examples/formatting.rs (line 107)
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
fn main() {
let mut table = table!(["Value 1", "Value 2"], ["Value three", "Value four"]);
table.set_titles(row!["Title 1", "Title 2"]);
// Print
// +-------------+------------+
// | Title 1 | Title 2 |
// +-------------+------------+
// | Value 1 | Value 2 |
// | Value three | Value four |
// +-------------+------------+
println!("FORMAT_NO_LINESEP_WITH_TITLE :");
table.set_format(*format::consts::FORMAT_NO_LINESEP_WITH_TITLE);
table.printstd();
println!("");
// Print
// -------------------------
// Title 1 Title 2
// =========================
// Value 1 Value 2
// -------------------------
// Value three Value four
// -------------------------
println!("FORMAT_NO_COLSEP :");
table.set_format(*format::consts::FORMAT_NO_COLSEP);
table.printstd();
println!("");
// Print
// +-------------------------+
// | Title 1 Title 2 |
// +=========================+
// | Value 1 Value 2 |
// | Value three Value four |
// +-------------------------+
println!("FORMAT_BORDERS_ONLY :");
table.set_format(*format::consts::FORMAT_BORDERS_ONLY);
table.printstd();
println!("");
// Custom format can be implemented using `prettytable::format::FormatBuilder`
// Example to print
// +-------------+------------+
// | Title 1 | Title 2 |
// | Value 1 | Value 2 |
// | Value three | Value four |
// +-------------+------------+
println!("Custom :");
table.set_format(
format::FormatBuilder::new()
.column_separator('|')
.borders('|')
.separators(
&[format::LinePosition::Top, format::LinePosition::Bottom],
format::LineSeparator::new('-', '+', '+', '+'),
)
.padding(1, 1)
.build(),
);
table.printstd();
// Customized format with unicode
// Example to print
// ┌─────────────┬────────────┐
// │ Title 1 │ Title 2 │
// ├─────────────┼────────────┤
// │ Value 1 │ Value 2 │
// ├─────────────┼────────────┤
// │ Value three │ Value four │
// └─────────────┴────────────┘
println!("With unicode:");
table.set_format(
format::FormatBuilder::new()
.column_separator('│')
.borders('│')
.separators(
&[format::LinePosition::Top],
format::LineSeparator::new('─', '┬', '┌', '┐'),
)
.separators(
&[format::LinePosition::Intern],
format::LineSeparator::new('─', '┼', '├', '┤'),
)
.separators(
&[format::LinePosition::Bottom],
format::LineSeparator::new('─', '┴', '└', '┘'),
)
.padding(1, 1)
.build(),
);
table.printstd();
// Customized format with unicode and different padding
// Example to print
// ┌───────────────┬──────────────┐
// │ Title 1 │ Title 2 │
// ├───────────────┼──────────────┤
// │ Value 1 │ Value 2 │
// ├───────────────┼──────────────┤
// │ Value three │ Value four │
// └───────────────┴──────────────┘
// Change individual format settings
println!("With unicode and padding:");
table.get_format().padding(2, 2);
table.printstd();
}
sourcepub fn column_separator(&mut self, separator: char)
pub fn column_separator(&mut self, separator: char)
Set the character used for internal column separation
sourcepub fn left_border(&mut self, border: char)
pub fn left_border(&mut self, border: char)
Set the character used for left table border
sourcepub fn right_border(&mut self, border: char)
pub fn right_border(&mut self, border: char)
Set the character used for right table border
sourcepub fn separator(&mut self, what: LinePosition, separator: LineSeparator)
pub fn separator(&mut self, what: LinePosition, separator: LineSeparator)
Set a line separator
sourcepub fn separators(&mut self, what: &[LinePosition], separator: LineSeparator)
pub fn separators(&mut self, what: &[LinePosition], separator: LineSeparator)
Set format for multiple kind of line separator
sourcepub fn indent(&mut self, spaces: usize)
pub fn indent(&mut self, spaces: usize)
Set global indentation in spaces used when rendering a table
sourcepub fn get_indent(&self) -> usize
pub fn get_indent(&self) -> usize
Get global indentation in spaces used when rendering a table
sourcepub fn get_column_separator(&self, pos: ColumnPosition) -> Option<char>
pub fn get_column_separator(&self, pos: ColumnPosition) -> Option<char>
Returns the character used to separate columns.
pos
specify if the separator is left/right final or internal to the table
Trait Implementations§
source§impl Clone for TableFormat
impl Clone for TableFormat
source§fn clone(&self) -> TableFormat
fn clone(&self) -> TableFormat
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TableFormat
impl Debug for TableFormat
source§impl Default for TableFormat
impl Default for TableFormat
source§impl From<TableFormat> for FormatBuilder
impl From<TableFormat> for FormatBuilder
source§fn from(fmt: TableFormat) -> Self
fn from(fmt: TableFormat) -> Self
Converts to this type from the input type.
source§impl Hash for TableFormat
impl Hash for TableFormat
source§impl PartialEq<TableFormat> for TableFormat
impl PartialEq<TableFormat> for TableFormat
source§fn eq(&self, other: &TableFormat) -> bool
fn eq(&self, other: &TableFormat) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.