//! This module contains a [`Padding`] setting of a cell on a [`Table`]. //! //! # Example //! #![cfg_attr(feature = "std", doc = "```")] #![cfg_attr(not(feature = "std"), doc = "```ignore")] //! use tabled::{Table, settings::{Padding, Style, Modify, object::Cell}}; //! //! let table = Table::new("2022".chars()) //! .with(Style::modern()) //! .with(Modify::new((2, 0)).with(Padding::new(1, 1, 2, 2))) //! .to_string(); //! //! assert_eq!( //! table, //! concat!( //! "┌──────┐\n", //! "│ char │\n", //! "├──────┤\n", //! "│ 2 │\n", //! "├──────┤\n", //! "│ │\n", //! "│ │\n", //! "│ 0 │\n", //! "│ │\n", //! "│ │\n", //! "├──────┤\n", //! "│ 2 │\n", //! "├──────┤\n", //! "│ 2 │\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, config::Entity}; #[cfg(feature = "std")] use crate::settings::CellOption; /// Padding is responsible for a left/right/top/bottom inner indent of a particular cell. /// #[cfg_attr(feature = "std", doc = "```")] #[cfg_attr(not(feature = "std"), doc = "```ignore")] /// # use tabled::{settings::{Style, Padding, object::Rows, Modify}, Table}; /// # let data: Vec<&'static str> = Vec::new(); /// let table = Table::new(&data).with(Modify::new(Rows::single(0)).with(Padding::new(0, 0, 1, 1).fill('>', '<', '^', 'V'))); /// ``` #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] pub struct Padding { indent: Sides, colors: Option>, } impl Padding { /// Construct's an Padding object. /// /// It uses space(' ') as a default fill character. /// To set a custom character you can use [`Padding::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, } } /// Construct's an Padding object with all sides set to 0. /// /// It uses space(' ') as a default fill character. /// To set a custom character you can use [`Padding::fill`] function. pub const fn zero() -> Self { Self::new(0, 0, 0, 0) } } impl Padding { /// The function, sets a characters for the padding 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 padding on an each side. pub fn colorize(self, left: C, right: C, top: C, bottom: C) -> Padding { Padding { indent: self.indent, colors: Some(Sides::new(left, right, top, bottom)), } } } #[cfg(feature = "std")] impl CellOption for Padding where C: Into> + Clone, { fn change(self, _: &mut R, cfg: &mut ColoredConfig, entity: Entity) { let indent = self.indent; let pad = Sides::new(indent.left, indent.right, indent.top, indent.bottom); cfg.set_padding(entity, pad); if let Some(colors) = &self.colors { let pad = Sides::new( Some(colors.left.clone().into()), Some(colors.right.clone().into()), Some(colors.top.clone().into()), Some(colors.bottom.clone().into()), ); cfg.set_padding_color(entity, pad); } } } #[cfg(feature = "std")] impl TableOption for Padding where C: Into> + Clone, { fn change(self, records: &mut R, cfg: &mut ColoredConfig, _: &mut D) { >::change(self, records, cfg, Entity::Global) } } impl TableOption for Padding where C: Into + Clone, { fn change(self, _: &mut R, cfg: &mut CompactConfig, _: &mut D) { *cfg = cfg.set_padding(self.indent); if let Some(c) = self.colors { let colors = Sides::new(c.left.into(), c.right.into(), c.top.into(), c.bottom.into()); *cfg = cfg.set_padding_color(colors); } } } impl TableOption for Padding where C: Into + Clone, { fn change(self, records: &mut R, cfg: &mut CompactMultilineConfig, dimension: &mut D) { self.change(records, cfg.as_mut(), dimension) } }