1 2 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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
use std::collections::HashMap;
use std::fmt;
use std::iter::IntoIterator;
use std::slice::{Iter, IterMut};
#[cfg(feature = "tty")]
use crossterm::terminal;
#[cfg(feature = "tty")]
use crossterm::tty::IsTty;
use strum::IntoEnumIterator;
use crate::cell::Cell;
use crate::column::Column;
use crate::row::Row;
use crate::style::presets::ASCII_FULL;
use crate::style::{ColumnConstraint, ContentArrangement, TableComponent};
use crate::utils::build_table;
/// This is the main interface for building a table.
/// Each table consists of [Rows](Row), which in turn contain [Cells](crate::cell::Cell).
///
/// There also exists a representation of a [Column].
/// Columns are automatically created when adding rows to a table.
#[derive(Debug)]
pub struct Table {
pub(crate) columns: Vec<Column>,
style: HashMap<TableComponent, char>,
pub(crate) header: Option<Row>,
pub(crate) rows: Vec<Row>,
pub(crate) arrangement: ContentArrangement,
pub(crate) delimiter: Option<char>,
#[cfg(feature = "tty")]
no_tty: bool,
#[cfg(feature = "tty")]
use_stderr: bool,
width: Option<u16>,
#[cfg(feature = "tty")]
enforce_styling: bool,
/// Define whether everything in a cells should be styled, including whitespaces
/// or whether only the text should be styled.
#[cfg(feature = "tty")]
pub(crate) style_text_only: bool,
}
impl fmt::Display for Table {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.lines().collect::<Vec<_>>().join("\n"))
}
}
impl Default for Table {
fn default() -> Self {
Self::new()
}
}
impl Table {
/// Create a new table with default ASCII styling.
pub fn new() -> Self {
let mut table = Self {
columns: Vec::new(),
header: None,
rows: Vec::new(),
arrangement: ContentArrangement::Disabled,
delimiter: None,
#[cfg(feature = "tty")]
no_tty: false,
#[cfg(feature = "tty")]
use_stderr: false,
width: None,
style: HashMap::new(),
#[cfg(feature = "tty")]
enforce_styling: false,
#[cfg(feature = "tty")]
style_text_only: false,
};
table.load_preset(ASCII_FULL);
table
}
/// This is an alternative `fmt` function, which simply removes any trailing whitespaces.
/// Trailing whitespaces often occur, when using tables without a right border.
pub fn trim_fmt(&self) -> String {
self.lines()
.map(|line| line.trim_end().to_string())
.collect::<Vec<_>>()
.join("\n")
}
/// This is an alternative to `fmt`, but rather returns an iterator to each line, rather than
/// one String separated by newlines.
pub fn lines(&self) -> impl Iterator<Item = String> {
build_table(self)
}
/// Set the header row of the table. This is usually the title of each column.\
/// There'll be no header unless you explicitly set it with this function.
///
/// ```
/// use comfy_table::{Table, Row};
///
/// let mut table = Table::new();
/// let header = Row::from(vec!["Header One", "Header Two"]);
/// table.set_header(header);
/// ```
pub fn set_header<T: Into<Row>>(&mut self, row: T) -> &mut Self {
let row = row.into();
self.autogenerate_columns(&row);
self.header = Some(row);
self
}
pub fn header(&self) -> Option<&Row> {
self.header.as_ref()
}
/// Returns the number of currently present columns.
///
/// ```
/// use comfy_table::Table;
///
/// let mut table = Table::new();
/// table.set_header(vec!["Col 1", "Col 2", "Col 3"]);
///
/// assert_eq!(table.column_count(), 3);
/// ```
pub fn column_count(&mut self) -> usize {
self.discover_columns();
self.columns.len()
}
/// Add a new row to the table.
///
/// ```
/// use comfy_table::{Table, Row};
///
/// let mut table = Table::new();
/// table.add_row(vec!["One", "Two"]);
/// ```
pub fn add_row<T: Into<Row>>(&mut self, row: T) -> &mut Self {
let mut row = row.into();
self.autogenerate_columns(&row);
row.index = Some(self.rows.len());
self.rows.push(row);
self
}
/// Add a new row to the table if the predicate evaluates to `true`.
///
/// ```
/// use comfy_table::{Table, Row};
///
/// let mut table = Table::new();
/// table.add_row_if(|index, row| true, vec!["One", "Two"]);
/// ```
pub fn add_row_if<P, T>(&mut self, predicate: P, row: T) -> &mut Self
where
P: Fn(usize, &T) -> bool,
T: Into<Row>,
{
if predicate(self.rows.len(), &row) {
return self.add_row(row);
}
self
}
/// Add multiple rows to the table.
///
/// ```
/// use comfy_table::{Table, Row};
///
/// let mut table = Table::new();
/// let rows = vec![
/// vec!["One", "Two"],
/// vec!["Three", "Four"]
/// ];
/// table.add_rows(rows);
/// ```
pub fn add_rows<I>(&mut self, rows: I) -> &mut Self
where
I: IntoIterator,
I::Item: Into<Row>,
{
for row in rows.into_iter() {
let mut row = row.into();
self.autogenerate_columns(&row);
row.index = Some(self.rows.len());
self.rows.push(row);
}
self
}
/// Add multiple rows to the table if the predicate evaluates to `true`.
///
/// ```
/// use comfy_table::{Table, Row};
///
/// let mut table = Table::new();
/// let rows = vec![
/// vec!["One", "Two"],
/// vec!["Three", "Four"]
/// ];
/// table.add_rows_if(|index, rows| true, rows);
/// ```
pub fn add_rows_if<P, I>(&mut self, predicate: P, rows: I) -> &mut Self
where
P: Fn(usize, &I) -> bool,
I: IntoIterator,
I::Item: Into<Row>,
{
if predicate(self.rows.len(), &rows) {
return self.add_rows(rows);
}
self
}
/// Returns the number of currently present rows.
///
/// ```
/// use comfy_table::Table;
///
/// let mut table = Table::new();
/// table.add_row(vec!["One", "Two"]);
///
/// assert_eq!(table.row_count(), 1);
/// ```
pub fn row_count(&self) -> usize {
self.rows.len()
}
/// Returns if the table is empty (contains no data rows).
///
/// ```
/// use comfy_table::Table;
///
/// let mut table = Table::new();
/// assert!(table.is_empty());
///
/// table.add_row(vec!["One", "Two"]);
/// assert!(!table.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.rows.is_empty()
}
/// Enforce a max width that should be used in combination with [dynamic content arrangement](ContentArrangement::Dynamic).\
/// This is usually not necessary, if you plan to output your table to a tty,
/// since the terminal width can be automatically determined.
pub fn set_width(&mut self, width: u16) -> &mut Self {
self.width = Some(width);
self
}
/// Get the expected width of the table.
///
/// This will be `Some(width)`, if the terminal width can be detected or if the table width is set via [set_width](Table::set_width).
///
/// If neither is not possible, `None` will be returned.\
/// This implies that both the [Dynamic](ContentArrangement::Dynamic) mode and the [Percentage](crate::style::Width::Percentage) constraint won't work.
#[cfg(feature = "tty")]
pub fn width(&self) -> Option<u16> {
if let Some(width) = self.width {
Some(width)
} else if self.is_tty() {
if let Ok((width, _)) = terminal::size() {
Some(width)
} else {
None
}
} else {
None
}
}
#[cfg(not(feature = "tty"))]
pub fn width(&self) -> Option<u16> {
self.width
}
/// Specify how Comfy Table should arrange the content in your table.
///
/// ```
/// use comfy_table::{Table, ContentArrangement};
///
/// let mut table = Table::new();
/// table.set_content_arrangement(ContentArrangement::Dynamic);
/// ```
pub fn set_content_arrangement(&mut self, arrangement: ContentArrangement) -> &mut Self {
self.arrangement = arrangement;
self
}
/// Get the current content arrangement of the table.
pub fn content_arrangement(&self) -> ContentArrangement {
self.arrangement.clone()
}
/// Set the delimiter used to split text in all cells.
///
/// A custom delimiter on a cell in will overwrite the column's delimiter.\
/// Normal text uses spaces (` `) as delimiters. This is necessary to help comfy-table
/// understand the concept of _words_.
pub fn set_delimiter(&mut self, delimiter: char) -> &mut Self {
self.delimiter = Some(delimiter);
self
}
/// In case you are sure you don't want export tables to a tty or you experience
/// problems with tty specific code, you can enforce a non_tty mode.
///
/// This disables:
///
/// - width lookup from the current tty
/// - Styling and attributes on cells (unless you use [Table::enforce_styling])
///
/// If you use the [dynamic content arrangement](ContentArrangement::Dynamic),
/// you need to set the width of your desired table manually with [set_width](Table::set_width).
#[cfg(feature = "tty")]
pub fn force_no_tty(&mut self) -> &mut Self {
self.no_tty = true;
self
}
/// Use this function to check whether `stderr` is a tty.
///
/// The default is `stdout`.
#[cfg(feature = "tty")]
pub fn use_stderr(&mut self) -> &mut Self {
self.use_stderr = true;
self
}
/// Returns whether the table will be handled as if it's printed to a tty.
///
/// By default, comfy-table looks at `stdout` and checks whether it's a tty.
/// This behavior can be changed via [Table::force_no_tty] and [Table::use_stderr].
#[cfg(feature = "tty")]
pub fn is_tty(&self) -> bool {
if self.no_tty {
return false;
}
if self.use_stderr {
::std::io::stderr().is_tty()
} else {
::std::io::stdout().is_tty()
}
}
/// Enforce terminal styling.
///
/// Only useful if you forcefully disabled tty, but still want those fancy terminal styles.
///
/// ```
/// use comfy_table::Table;
///
/// let mut table = Table::new();
/// table.force_no_tty()
/// .enforce_styling();
/// ```
#[cfg(feature = "tty")]
pub fn enforce_styling(&mut self) -> &mut Self {
self.enforce_styling = true;
self
}
/// Returns whether the content of this table should be styled with the current settings and
/// environment.
#[cfg(feature = "tty")]
pub fn should_style(&self) -> bool {
if self.enforce_styling {
return true;
}
self.is_tty()
}
/// By default, the whole content of a cells will be styled.
/// Calling this function disables this behavior for all cells, resulting in
/// only the text of cells being styled.
#[cfg(feature = "tty")]
pub fn style_text_only(&mut self) {
self.style_text_only = true;
}
/// Convenience method to set a [ColumnConstraint] for all columns at once.
/// Constraints are used to influence the way the columns will be arranged.
/// Check out their docs for more information.
///
/// **Attention:**
/// This function should be called after at least one row (or the headers) has been added to the table.
/// Before that, the columns won't initialized.
///
/// If more constraints are passed than there are columns, any superfluous constraints will be ignored.
/// ```
/// use comfy_table::{Width::*, CellAlignment, ColumnConstraint::*, ContentArrangement, Table};
///
/// let mut table = Table::new();
/// table.add_row(&vec!["one", "two", "three"])
/// .set_content_arrangement(ContentArrangement::Dynamic)
/// .set_constraints(vec![
/// UpperBoundary(Fixed(15)),
/// LowerBoundary(Fixed(20)),
/// ]);
/// ```
pub fn set_constraints<T: IntoIterator<Item = ColumnConstraint>>(
&mut self,
constraints: T,
) -> &mut Self {
let mut constraints = constraints.into_iter();
for column in self.column_iter_mut() {
if let Some(constraint) = constraints.next() {
column.set_constraint(constraint);
} else {
break;
}
}
self
}
/// This function creates a TableStyle from a given preset string.\
/// Preset strings can be found in `styling::presets::*`.
///
/// You can also write your own preset strings and use them with this function.
/// There's the convenience method [Table::current_style_as_preset], which prints you a preset
/// string from your current style configuration. \
/// The function expects the to-be-drawn characters to be in the same order as in the [TableComponent] enum.
///
/// If the string isn't long enough, the default [ASCII_FULL] style will be used for all remaining components.
///
/// If the string is too long, remaining charaacters will be simply ignored.
pub fn load_preset(&mut self, preset: &str) -> &mut Self {
let mut components = TableComponent::iter();
for character in preset.chars() {
if let Some(component) = components.next() {
// White spaces mean "don't draw this" in presets
// If we want to override the default preset, we need to remove
// this component from the HashMap in case we find a whitespace.
if character == ' ' {
self.remove_style(component);
continue;
}
self.set_style(component, character);
} else {
break;
}
}
self
}
/// Returns the current style as a preset string.
///
/// A pure convenience method, so you're not force to fiddle with those preset strings yourself.
///
/// ```
/// use comfy_table::Table;
/// use comfy_table::presets::UTF8_FULL;
///
/// let mut table = Table::new();
/// table.load_preset(UTF8_FULL);
///
/// assert_eq!(UTF8_FULL, table.current_style_as_preset())
/// ```
pub fn current_style_as_preset(&mut self) -> String {
let components = TableComponent::iter();
let mut preset_string = String::new();
for component in components {
match self.style(component) {
None => preset_string.push(' '),
Some(character) => preset_string.push(character),
}
}
preset_string
}
/// Modify a preset with a modifier string from [modifiers](crate::style::modifiers).
///
/// For instance, the [UTF8_ROUND_CORNERS](crate::style::modifiers::UTF8_ROUND_CORNERS) modifies all corners to be round UTF8 box corners.
///
/// ```
/// use comfy_table::Table;
/// use comfy_table::presets::UTF8_FULL;
/// use comfy_table::modifiers::UTF8_ROUND_CORNERS;
///
/// let mut table = Table::new();
/// table.load_preset(UTF8_FULL);
/// table.apply_modifier(UTF8_ROUND_CORNERS);
/// ```
pub fn apply_modifier(&mut self, modifier: &str) -> &mut Self {
let mut components = TableComponent::iter();
for character in modifier.chars() {
// Skip spaces while applying modifiers.
if character == ' ' {
components.next();
continue;
}
if let Some(component) = components.next() {
self.set_style(component, character);
} else {
break;
}
}
self
}
/// Define the char that will be used to draw a specific component.\
/// Look at [TableComponent] to see all stylable components
///
/// If `None` is supplied, the element won't be displayed.\
/// In case of a e.g. *BorderIntersection a whitespace will be used as placeholder,
/// unless related borders and and corners are set to `None` as well.
///
/// For example, if `TopBorderIntersections` is `None` the first row would look like this:
///
/// ```text
/// +------ ------+
/// | this | test |
/// ```
///
/// If in addition `TopLeftCorner`,`TopBorder` and `TopRightCorner` would be `None` as well,
/// the first line wouldn't be displayed at all.
///
/// ```
/// use comfy_table::Table;
/// use comfy_table::presets::UTF8_FULL;
/// use comfy_table::TableComponent::*;
///
/// let mut table = Table::new();
/// // Load the UTF8_FULL preset
/// table.load_preset(UTF8_FULL);
/// // Set all outer corners to round UTF8 corners
/// // This is basically the same as the UTF8_ROUND_CORNERS modifier
/// table.set_style(TopLeftCorner, '╭');
/// table.set_style(TopRightCorner, '╮');
/// table.set_style(BottomLeftCorner, '╰');
/// table.set_style(BottomRightCorner, '╯');
/// ```
pub fn set_style(&mut self, component: TableComponent, character: char) -> &mut Self {
self.style.insert(component, character);
self
}
/// Get a copy of the char that's currently used for drawing this component.
/// ```
/// use comfy_table::Table;
/// use comfy_table::TableComponent::*;
///
/// let mut table = Table::new();
/// assert_eq!(table.style(TopLeftCorner), Some('+'));
/// ```
pub fn style(&mut self, component: TableComponent) -> Option<char> {
self.style.get(&component).copied()
}
/// Remove the style for a specific component of the table.\
/// By default, a space will be used as a placeholder instead.\
/// Though, if for instance all components of the left border are removed, the left border won't be displayed.
pub fn remove_style(&mut self, component: TableComponent) -> &mut Self {
self.style.remove(&component);
self
}
/// Get a reference to a specific column.
pub fn column(&self, index: usize) -> Option<&Column> {
self.columns.get(index)
}
/// Get a mutable reference to a specific column.
pub fn column_mut(&mut self, index: usize) -> Option<&mut Column> {
self.columns.get_mut(index)
}
/// Iterator over all columns
pub fn column_iter(&self) -> Iter<Column> {
self.columns.iter()
}
/// Get a mutable iterator over all columns.
///
/// ```
/// use comfy_table::{Width::*, ColumnConstraint::*, Table};
///
/// let mut table = Table::new();
/// table.add_row(&vec!["First", "Second", "Third"]);
///
/// // Add a ColumnConstraint to each column (left->right)
/// // first -> min width of 10
/// // second -> max width of 8
/// // third -> fixed width of 10
/// let constraints = vec![
/// LowerBoundary(Fixed(10)),
/// UpperBoundary(Fixed(8)),
/// Absolute(Fixed(10)),
/// ];
///
/// // Add the constraints to their respective column
/// for (column_index, column) in table.column_iter_mut().enumerate() {
/// let constraint = constraints.get(column_index).unwrap();
/// column.set_constraint(*constraint);
/// }
/// ```
pub fn column_iter_mut(&mut self) -> IterMut<Column> {
self.columns.iter_mut()
}
/// Get a mutable iterator over cells of a column.
/// The iterator returns a nested `Option<Option<Cell>>`, since there might be
/// rows that are missing this specific Cell.
///
/// ```
/// use comfy_table::Table;
/// let mut table = Table::new();
/// table.add_row(&vec!["First", "Second"]);
/// table.add_row(&vec!["Third"]);
/// table.add_row(&vec!["Fourth", "Fifth"]);
///
/// // Create an iterator over the second column
/// let mut cell_iter = table.column_cells_iter(1);
/// assert_eq!(cell_iter.next().unwrap().unwrap().content(), "Second");
/// assert!(cell_iter.next().unwrap().is_none());
/// assert_eq!(cell_iter.next().unwrap().unwrap().content(), "Fifth");
/// assert!(cell_iter.next().is_none());
/// ```
pub fn column_cells_iter(&self, column_index: usize) -> ColumnCellIter {
ColumnCellIter {
rows: &self.rows,
column_index,
row_index: 0,
}
}
/// Get a mutable iterator over cells of a column, including the header cell.
/// The header cell will be the very first cell returned.
/// The iterator returns a nested `Option<Option<Cell>>`, since there might be
/// rows that are missing this specific Cell.
///
/// ```
/// use comfy_table::Table;
/// let mut table = Table::new();
/// table.set_header(&vec!["A", "B"]);
/// table.add_row(&vec!["First", "Second"]);
/// table.add_row(&vec!["Third"]);
/// table.add_row(&vec!["Fourth", "Fifth"]);
///
/// // Create an iterator over the second column
/// let mut cell_iter = table.column_cells_with_header_iter(1);
/// assert_eq!(cell_iter.next().unwrap().unwrap().content(), "B");
/// assert_eq!(cell_iter.next().unwrap().unwrap().content(), "Second");
/// assert!(cell_iter.next().unwrap().is_none());
/// assert_eq!(cell_iter.next().unwrap().unwrap().content(), "Fifth");
/// assert!(cell_iter.next().is_none());
/// ```
pub fn column_cells_with_header_iter(&self, column_index: usize) -> ColumnCellsWithHeaderIter {
ColumnCellsWithHeaderIter {
header_checked: false,
header: &self.header,
rows: &self.rows,
column_index,
row_index: 0,
}
}
/// Reference to a specific row
pub fn row(&self, index: usize) -> Option<&Row> {
self.rows.get(index)
}
/// Mutable reference to a specific row
pub fn row_mut(&mut self, index: usize) -> Option<&mut Row> {
self.rows.get_mut(index)
}
/// Iterator over all rows
pub fn row_iter(&self) -> Iter<Row> {
self.rows.iter()
}
/// Get a mutable iterator over all rows.
///
/// ```
/// use comfy_table::Table;
/// let mut table = Table::new();
/// table.add_row(&vec!["First", "Second", "Third"]);
///
/// // Add the constraints to their respective row
/// for row in table.row_iter_mut() {
/// row.max_height(5);
/// }
/// assert!(table.row_iter_mut().len() == 1);
/// ```
pub fn row_iter_mut(&mut self) -> IterMut<Row> {
self.rows.iter_mut()
}
/// Return a vector representing the maximum amount of characters in any line of this column.\
///
/// **Attention** This scans the whole current content of the table.
pub fn column_max_content_widths(&self) -> Vec<u16> {
fn set_max_content_widths(max_widths: &mut [u16], row: &Row) {
// Get the max width for each cell of the row
let row_max_widths = row.max_content_widths();
for (index, width) in row_max_widths.iter().enumerate() {
let mut width = (*width).try_into().unwrap_or(u16::MAX);
// A column's content is at least 1 char wide.
width = std::cmp::max(1, width);
// Set a new max, if the current cell is the longest for that column.
let current_max = max_widths[index];
if current_max < width {
max_widths[index] = width;
}
}
}
// The vector that'll contain the max widths per column.
let mut max_widths = vec![0; self.columns.len()];
if let Some(header) = &self.header {
set_max_content_widths(&mut max_widths, header);
}
// Iterate through all rows of the table.
for row in self.rows.iter() {
set_max_content_widths(&mut max_widths, row);
}
max_widths
}
pub(crate) fn style_or_default(&self, component: TableComponent) -> String {
match self.style.get(&component) {
None => " ".to_string(),
Some(character) => character.to_string(),
}
}
pub(crate) fn style_exists(&self, component: TableComponent) -> bool {
self.style.get(&component).is_some()
}
/// Autogenerate new columns, if a row is added with more cells than existing columns.
fn autogenerate_columns(&mut self, row: &Row) {
if row.cell_count() > self.columns.len() {
for index in self.columns.len()..row.cell_count() {
self.columns.push(Column::new(index));
}
}
}
/// Calling this might be necessary if you add new cells to rows that're already added to the
/// table.
///
/// If more cells than're currently know to the table are added to that row,
/// the table cannot know about these, since new [Column]s are only
/// automatically detected when a new row is added.
///
/// To make sure everything works as expected, just call this function if you're adding cells
/// to rows that're already added to the table.
pub fn discover_columns(&mut self) {
for row in self.rows.iter() {
if row.cell_count() > self.columns.len() {
for index in self.columns.len()..row.cell_count() {
self.columns.push(Column::new(index));
}
}
}
}
}
/// An iterator over cells of a specific column.
/// A dedicated struct is necessary, as data is usually handled by rows and thereby stored in
/// `Table::rows`. This type is returned by [Table::column_cells_iter].
pub struct ColumnCellIter<'a> {
rows: &'a [Row],
column_index: usize,
row_index: usize,
}
impl<'a> Iterator for ColumnCellIter<'a> {
type Item = Option<&'a Cell>;
fn next(&mut self) -> Option<Option<&'a Cell>> {
// Check if there's a next row
if let Some(row) = self.rows.get(self.row_index) {
self.row_index += 1;
// Return the cell (if it exists).
return Some(row.cells.get(self.column_index));
}
None
}
}
/// An iterator over cells of a specific column.
/// A dedicated struct is necessary, as data is usually handled by rows and thereby stored in
/// `Table::rows`. This type is returned by [Table::column_cells_iter].
pub struct ColumnCellsWithHeaderIter<'a> {
header_checked: bool,
header: &'a Option<Row>,
rows: &'a [Row],
column_index: usize,
row_index: usize,
}
impl<'a> Iterator for ColumnCellsWithHeaderIter<'a> {
type Item = Option<&'a Cell>;
fn next(&mut self) -> Option<Option<&'a Cell>> {
// Get the header as the first cell
if !self.header_checked {
self.header_checked = true;
return match self.header {
Some(header) => {
// Return the cell (if it exists).
Some(header.cells.get(self.column_index))
}
None => Some(None),
};
}
// Check if there's a next row
if let Some(row) = self.rows.get(self.row_index) {
self.row_index += 1;
// Return the cell (if it exists).
return Some(row.cells.get(self.column_index));
}
None
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_column_generation() {
let mut table = Table::new();
table.set_header(&vec!["thr", "four", "fivef"]);
// When adding a new row, columns are automatically generated
assert_eq!(table.columns.len(), 3);
// The max content width is also correctly set for each column
assert_eq!(table.column_max_content_widths(), vec![3, 4, 5]);
// When adding a new row, the max content width is updated accordingly
table.add_row(&vec!["four", "fivef", "very long text with 23"]);
assert_eq!(table.column_max_content_widths(), vec![4, 5, 22]);
// Now add a row that has column lines. The max content width shouldn't change
table.add_row(&vec!["", "", "shorter"]);
assert_eq!(table.column_max_content_widths(), vec![4, 5, 22]);
println!("{table}");
}
}