Enum TrimStrategy

pub enum TrimStrategy {
    Vertical,
    Horizontal,
    Both,
    None,
}

TrimStrategy determines if it’s allowed to use empty space while doing Alignment.

Examples

use tabled::{
    Table,
    settings::{
        Style, Modify, Alignment, object::Segment,
        formatting::{TrimStrategy, AlignmentStrategy}
    }
};

let mut table = Table::new(&["   Hello World"]);
table
    .with(Style::modern())
    .with(
        Modify::new(Segment::all())
            .with(Alignment::left())
            .with(TrimStrategy::Horizontal)
    );

// Note that nothing was changed exactly.

assert_eq!(
    table.to_string(),
    "┌────────────────┐\n\
     │ &str           │\n\
     ├────────────────┤\n\
     │ Hello World    │\n\
     └────────────────┘"
);

// To trim lines you would need also set [`AlignmentStrategy`].
table.with(Modify::new(Segment::all()).with(AlignmentStrategy::PerLine));

assert_eq!(
    table.to_string(),
    "┌────────────────┐\n\
     │ &str           │\n\
     ├────────────────┤\n\
     │ Hello World    │\n\
     └────────────────┘"
);

let mut table = Table::new(&["   \n\n\n    Hello World"]);
table
    .with(Style::modern())
    .with(
        Modify::new(Segment::all())
            .with(Alignment::center())
            .with(Alignment::top())
            .with(TrimStrategy::Vertical)
    );

assert_eq!(
    table.to_string(),
    "┌─────────────────┐\n\
     │      &str       │\n\
     ├─────────────────┤\n\
     │     Hello World │\n\
     │                 │\n\
     │                 │\n\
     │                 │\n\
     └─────────────────┘"
);

Variants

Vertical

Allow vertical trim.

Horizontal

Allow horizontal trim.

Both

Allow horizontal and vertical trim.

None

Doesn’t allow any trim.

Trait Implementations

impl<R> CellOption<R, ColoredConfig> for TrimStrategy

fn change(self, _: &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 Clone for TrimStrategy

fn clone(&self) -> TrimStrategy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrimStrategy

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

Formats the value using the given formatter.

impl Ord for TrimStrategy

fn cmp(&self, other: &TrimStrategy) -> 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 PartialEq for TrimStrategy

fn eq(&self, other: &TrimStrategy) -> 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 PartialOrd for TrimStrategy

fn partial_cmp(&self, other: &TrimStrategy) -> 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<R, D> TableOption<R, ColoredConfig, D> for TrimStrategy

fn change(self, records: &mut R, cfg: &mut ColoredConfig, _: &mut D)

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 Copy for TrimStrategy

impl Eq for TrimStrategy

impl StructuralPartialEq for TrimStrategy