Struct MinWidth

pub struct MinWidth<W = usize, P = PriorityNone> { /* private fields */ }

MinWidth changes a content in case if it’s length is lower then the boundary.

It can be applied to a whole table.

It does nothing in case if the content’s length is bigger then the boundary.

Be aware that further changes of the table may cause the width being not set. For example applying Padding after applying MinWidth will make the former have no affect. (You should use Padding first).

Be aware that it doesn’t consider padding. So if you want to set a exact width you might need to use Padding to set it to 0.

Examples

Cell change

use tabled::{Table, settings::{object::Segment, Width, Style, Modify}};

let data = ["Hello", "World", "!"];

let table = Table::new(&data)
    .with(Style::markdown())
    .with(Modify::new(Segment::all()).with(Width::increase(10)));

Table change

use tabled::{Table, settings::Width};

let table = Table::new(&["Hello World!"]).with(Width::increase(5));

Implementations

impl<W> MinWidth<W>

where W: Measurement<Width>,

pub const fn new(width: W) -> Self

Creates a new instance of MinWidth.

impl<W, P> MinWidth<W, P>

pub fn fill_with(self, c: char) -> Self

Set’s a fill character which will be used to fill the space when increasing the length of the string to the set boundary.

Used only if changing cells.

pub fn priority<PP: Peaker>(self, peacker: PP) -> MinWidth<W, PP>

Priority defines the logic by which a increase of width will be applied when is done for the whole table.

• PriorityNone which inc the columns one after another.
• PriorityMax inc the biggest columns first.
• PriorityMin inc the lowest columns first.

Trait Implementations

impl<W, R, P> CellOption<R, ColoredConfig> for MinWidth<W, P>

where W: Measurement<Width>, R: Records + ExactRecords + PeekableRecords + RecordsMut<String>, for<'a> &'a R: Records, for<'a> <<&'a R as Records>::Iter as IntoRecords>::Cell: AsRef<str>,

fn change(self, records: &mut R, cfg: &mut ColoredConfig, entity: Entity)

Modification function of a certail part of a grid targeted by Entity.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.

impl<W: Clone, P: Clone> Clone for MinWidth<W, P>

fn clone(&self) -> MinWidth<W, P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Debug, P: Debug> Debug for MinWidth<W, P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: Ord, P: Ord> Ord for MinWidth<W, P>

fn cmp(&self, other: &MinWidth<W, P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<W: PartialEq, P: PartialEq> PartialEq for MinWidth<W, P>

fn eq(&self, other: &MinWidth<W, P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<W: PartialOrd, P: PartialOrd> PartialOrd for MinWidth<W, P>

fn partial_cmp(&self, other: &MinWidth<W, P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<W, P, R> TableOption<R, ColoredConfig, CompleteDimension> for MinWidth<W, P>

where W: Measurement<Width>, P: Peaker, R: Records + ExactRecords + PeekableRecords, for<'a> &'a R: Records, for<'a> <<&'a R as Records>::Iter as IntoRecords>::Cell: Cell + AsRef<str>,

fn change( self, records: &mut R, cfg: &mut ColoredConfig, dims: &mut CompleteDimension, )

The function modificaties of records and a grid configuration.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.

impl<W: Copy, P: Copy> Copy for MinWidth<W, P>

impl<W: Eq, P: Eq> Eq for MinWidth<W, P>

impl<W, P> StructuralPartialEq for MinWidth<W, P>