Add override for color preference when printing tables + polish some APIs

Author: devashishdxt

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cli-table"
-version = "0.3.1"
+version = "0.3.2"
 authors = ["Devashish Dixit <devashishdxt@gmail.com>"]
 license = "MIT/Apache-2.0"
 description = "A crate for printing tables on command line"

examples/simple.rs

@@ -30,7 +30,9 @@ fn main() -> Result<(), Box<dyn Error>> {
                 Cell::new("25", justify_right),
             ]),
         ],
-        TableFormat::default().foreground(Color::Red),
+        TableFormat::builder()
+            .foreground_color(Some(Color::Red))
+            .build(),
     )?;
 
     table.print_stdout()?;

src/cell.rs

@@ -8,7 +8,7 @@ use unicode_width::UnicodeWidthStr;
 
 use crate::format::{Align, CellFormat, Justify, Padding};
 
-/// A `Cell` in a [`Table`](struct.Table.html)
+/// A `Cell` in a [`Table`](crate::Table)
 #[derive(Debug)]
 pub struct Cell {
     pub(crate) data: Vec<String>,
@@ -18,7 +18,7 @@ pub struct Cell {
 }
 
 impl Cell {
-    /// Creates a new [`Cell`](struct.Cell.html)
+    /// Creates a new [`Cell`](crate::Cell)
     pub fn new<T: Display + ?Sized>(data: &T, format: CellFormat) -> Self {
         let data: Vec<String> = data.to_string().lines().map(ToString::to_string).collect();
         let height = data.len() + format.padding.top + format.padding.bottom;

src/error.rs

@@ -3,7 +3,7 @@ use std::fmt;
 /// Errors returned by functions in this crate
 #[derive(Debug)]
 pub enum Error {
-    /// Returned when there is a mismatch in number of columns in different rows of a [`Table`](struct.Table.html)
+    /// Returned when there is a mismatch in number of columns in different rows of a [`Table`](crate::Table)
     MismatchedColumns,
 }
 

src/format.rs

@@ -1,15 +1,16 @@
-//! Utilities for formatting of a [`Table`](struct.Table.html)
+//! Utilities for formatting of a [`Table`](crate::Table)
 mod cell;
 mod table;
 
 pub use self::cell::{
     Align, CellFormat, CellFormatBuilder, Color, Justify, Padding, PaddingBuilder,
 };
 pub use self::table::{
-    Border, BorderBuilder, HorizontalLine, Separator, SeparatorBuilder, TableFormat, VerticalLine,
+    Border, BorderBuilder, HorizontalLine, Separator, SeparatorBuilder, TableFormat,
+    TableFormatBuilder, VerticalLine,
 };
 
-/// Format with borders, column separators and row separators (calling `Default::default()` on [`TableFormat`](struct.TableFormat.html)
+/// Format with borders, column separators and row separators (calling `Default::default()` on [`TableFormat`](crate::format::TableFormat)
 /// also returns this format)
 ///
 /// ```markdown
@@ -24,7 +25,7 @@ pub use self::table::{
 /// +------------+----------------+
 /// ```
 pub const BORDER_COLUMN_ROW: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: Some(HorizontalLine {
             left_end: '+',
@@ -65,7 +66,7 @@ pub const BORDER_COLUMN_ROW: TableFormat = TableFormat {
 /// +------------+----------------+
 /// ```
 pub const BORDER_COLUMN_TITLE: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: Some(HorizontalLine {
             left_end: '+',
@@ -105,7 +106,7 @@ pub const BORDER_COLUMN_TITLE: TableFormat = TableFormat {
 /// +------------+----------------+
 /// ```
 pub const BORDER_COLUMN_NO_ROW: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: Some(HorizontalLine {
             left_end: '+',
@@ -139,7 +140,7 @@ pub const BORDER_COLUMN_NO_ROW: TableFormat = TableFormat {
 ///  Scooby Doo |             25
 /// ```
 pub const NO_BORDER_COLUMN_TITLE: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: None,
         bottom: None,
@@ -170,7 +171,7 @@ pub const NO_BORDER_COLUMN_TITLE: TableFormat = TableFormat {
 ///  Scooby Doo |             25
 /// ```
 pub const NO_BORDER_COLUMN_ROW: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: None,
         bottom: None,
@@ -203,7 +204,7 @@ pub const NO_BORDER_COLUMN_ROW: TableFormat = TableFormat {
 /// +----------------------------+
 /// ```
 pub const BORDER_NO_COLUMN_ROW: TableFormat = TableFormat {
-    foreground: None,
+    foreground_color: None,
     border: Border {
         top: Some(HorizontalLine {
             left_end: '+',

src/format/cell.rs

@@ -1,6 +1,6 @@
 pub use termcolor::Color;
 
-/// Struct for configuring a [`Cell`](struct.Cell.html)'s format
+/// Struct for configuring a [`Cell`](crate::Cell)'s format
 #[derive(Debug, Clone, Copy, Default)]
 pub struct CellFormat {
     pub(crate) justify: Justify,
@@ -13,75 +13,75 @@ pub struct CellFormat {
 }
 
 impl CellFormat {
-    /// Creates a new builder for [`CellFormat`](struct.CellFormat.html)
+    /// Creates a new builder for [`CellFormat`](crate::format::CellFormat)
     #[inline]
     pub fn builder() -> CellFormatBuilder {
         Default::default()
     }
 }
 
-/// Builder for [`CellFormat`](struct.CellFormat.html)
+/// Builder for [`CellFormat`](crate::format::CellFormat)
 #[derive(Debug, Default)]
 pub struct CellFormatBuilder(CellFormat);
 
 impl CellFormatBuilder {
-    /// Justify contents of a [`Cell`](struct.Cell.html)
+    /// Justify contents of a [`Cell`](crate::Cell)
     #[inline]
     pub fn justify(mut self, justify: Justify) -> Self {
         self.0.justify = justify;
         self
     }
 
-    /// Align contents of a [`Cell`](struct.Cell.html)
+    /// Align contents of a [`Cell`](crate::Cell)
     #[inline]
     pub fn align(mut self, align: Align) -> Self {
         self.0.align = align;
         self
     }
 
-    /// Sets padding of a [`Cell`](struct.Cell.html)
+    /// Sets padding of a [`Cell`](crate::Cell)
     #[inline]
     pub fn padding(mut self, padding: Padding) -> Self {
         self.0.padding = padding;
         self
     }
 
-    /// Set foreground color of a [`Cell`](struct.Cell.html)
+    /// Set foreground color of a [`Cell`](crate::Cell)
     #[inline]
     pub fn foreground_color(mut self, foreground_color: Option<Color>) -> Self {
         self.0.foreground_color = foreground_color;
         self
     }
 
-    /// Set background color of a [`Cell`](struct.Cell.html)
+    /// Set background color of a [`Cell`](crate::Cell)
     #[inline]
     pub fn background_color(mut self, background_color: Option<Color>) -> Self {
         self.0.background_color = background_color;
         self
     }
 
-    /// Set contents of [`Cell`](struct.Cell.html) to be bold
+    /// Set contents of [`Cell`](crate::Cell) to be bold
     #[inline]
     pub fn bold(mut self, bold: bool) -> Self {
         self.0.bold = bold;
         self
     }
 
-    /// Set contents of [`Cell`](struct.Cell.html) to be underlined
+    /// Set contents of [`Cell`](crate::Cell) to be underlined
     #[inline]
     pub fn underline(mut self, underline: bool) -> Self {
         self.0.underline = underline;
         self
     }
 
-    /// Build [`CellFormat`](struct.CellFormat.html)
+    /// Build [`CellFormat`](crate::format::CellFormat)
     #[inline]
     pub fn build(self) -> CellFormat {
         self.0
     }
 }
 
-/// Used to horizontally justify contents of a [`Cell`](struct.Cell.html)
+/// Used to horizontally justify contents of a [`Cell`](crate::Cell)
 #[derive(Debug, Clone, Copy)]
 pub enum Justify {
     /// Justifies contents to left
@@ -99,7 +99,7 @@ impl Default for Justify {
     }
 }
 
-/// Used to vertically align contents of a [`Cell`](struct.Cell.html)
+/// Used to vertically align contents of a [`Cell`](crate::Cell)
 #[derive(Debug, Clone, Copy)]
 pub enum Align {
     /// Aligns contents to top
@@ -117,7 +117,7 @@ impl Default for Align {
     }
 }
 
-/// Used to add padding to the contents of a [`Cell`](struct.Cell.html)
+/// Used to add padding to the contents of a [`Cell`](crate::Cell)
 #[derive(Debug, Clone, Copy, Default)]
 pub struct Padding {
     /// Left padding
@@ -131,46 +131,46 @@ pub struct Padding {
 }
 
 impl Padding {
-    /// Creates a new builder for [`Padding`](struct.Padding.html)
+    /// Creates a new builder for [`Padding`](crate::format::Padding)
     pub fn builder() -> PaddingBuilder {
         Default::default()
     }
 }
 
-/// Builder for [`Padding`](struct.Padding.html)
+/// Builder for [`Padding`](crate::format::Padding)
 #[derive(Debug, Default)]
 pub struct PaddingBuilder(Padding);
 
 impl PaddingBuilder {
-    /// Sets left padding of a [`Cell`](struct.Cell.html)
+    /// Sets left padding of a [`Cell`](crate::Cell)
     #[inline]
     pub fn left(mut self, left_padding: usize) -> Self {
         self.0.left = left_padding;
         self
     }
 
-    /// Sets right padding of a [`Cell`](struct.Cell.html)
+    /// Sets right padding of a [`Cell`](crate::Cell)
     #[inline]
     pub fn right(mut self, right_padding: usize) -> Self {
         self.0.right = right_padding;
         self
     }
 
-    /// Sets top padding of a [`Cell`](struct.Cell.html)
+    /// Sets top padding of a [`Cell`](crate::Cell)
     #[inline]
     pub fn top(mut self, top_padding: usize) -> Self {
         self.0.top = top_padding;
         self
     }
 
-    /// Sets bottom padding of a [`Cell`](struct.Cell.html)
+    /// Sets bottom padding of a [`Cell`](crate::Cell)
     #[inline]
     pub fn bottom(mut self, bottom_padding: usize) -> Self {
         self.0.bottom = bottom_padding;
         self
     }
 
-    /// Build [`Padding`](struct.Padding.html)
+    /// Build [`Padding`](crate::format::Padding)
     #[inline]
     pub fn build(self) -> Padding {
         self.0