//! This module contains a Margin settings of a [`Table`]. //! //! # Example //! #![cfg_attr(feature = "std", doc = "```")] #![cfg_attr(not(feature = "std"), doc = "```ignore")] //! use tabled::{settings::{Margin, Style}, Table}; //! //! let data = vec!["Hello", "World", "!"]; //! //! let mut table = Table::new(data); //! table.with(Style::markdown()).with(Margin::new(3, 3, 1, 0)); //! //! assert_eq!( //! table.to_string(), //! concat!( //! " \n", //! " | &str | \n", //! " |-------| \n", //! " | Hello | \n", //! " | World | \n", //! " | ! | ", //! ) //! ); //! ``` //! //! [`Table`]: crate::Table use crate::{ grid::{ color::StaticColor, config::{CompactConfig, CompactMultilineConfig}, config::{Indent, Sides}, }, settings::TableOption, }; #[cfg(feature = "std")] use crate::grid::{color::AnsiColor, config::ColoredConfig}; /// Margin is responsible for a left/right/top/bottom outer indent of a grid. /// #[cfg_attr(feature = "std", doc = "```")] #[cfg_attr(not(feature = "std"), doc = "```ignore")] /// # use tabled::{settings::Margin, Table}; /// # let data: Vec<&'static str> = Vec::new(); /// let table = Table::new(&data) /// .with(Margin::new(1, 1, 1, 1).fill('>', '<', 'V', '^')); /// ``` #[derive(Debug, Clone)] pub struct Margin { indent: Sides, colors: Option>, } impl Margin { /// Construct's an Margin object. /// /// It uses space(' ') as a default fill character. /// To set a custom character you can use [`Margin::fill`] function. pub const fn new(left: usize, right: usize, top: usize, bottom: usize) -> Self { Self { indent: Sides::new( Indent::spaced(left), Indent::spaced(right), Indent::spaced(top), Indent::spaced(bottom), ), colors: None, } } } impl Margin { /// The function, sets a characters for the margin on an each side. pub const fn fill(mut self, left: char, right: char, top: char, bottom: char) -> Self { self.indent.left.fill = left; self.indent.right.fill = right; self.indent.top.fill = top; self.indent.bottom.fill = bottom; self } /// The function, sets a characters for the margin on an each side. pub fn colorize(self, left: C, right: C, top: C, bottom: C) -> Margin { Margin { indent: self.indent, colors: Some(Sides::new(left, right, top, bottom)), } } } #[cfg(feature = "std")] impl TableOption for Margin where C: Into> + Clone, { fn change(self, _: &mut R, cfg: &mut ColoredConfig, _: &mut D) { let indent = self.indent; let margin = Sides::new(indent.left, indent.right, indent.top, indent.bottom); cfg.set_margin(margin); if let Some(colors) = &self.colors { let margin = Sides::new( Some(colors.left.clone().into()), Some(colors.right.clone().into()), Some(colors.top.clone().into()), Some(colors.bottom.clone().into()), ); cfg.set_margin_color(margin); } } } impl TableOption for Margin where C: Into + Clone, { fn change(self, _: &mut R, cfg: &mut CompactConfig, _: &mut D) { *cfg = cfg.set_margin(self.indent); if let Some(c) = self.colors { // todo: make a new method (BECAUSE INTO doesn't work) try_into(); let colors = Sides::new(c.left.into(), c.right.into(), c.top.into(), c.bottom.into()); *cfg = cfg.set_margin_color(colors); } } } impl TableOption for Margin where C: Into + Clone, { fn change(self, records: &mut R, cfg: &mut CompactMultilineConfig, dimension: &mut D) { self.change(records, cfg.as_mut(), dimension) } }