Struct Truncate

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

Truncate cut the string to a given width if its length exceeds it. Otherwise keeps the content of a cell untouched.

The function is color aware if a color feature is on.

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.

Example

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

let table = Table::new(&["Hello World!"])
    .with(Modify::new(Segment::all()).with(Width::truncate(3)));

Implementations

impl<W> Truncate<'static, W>

where W: Measurement<Width>,

pub const fn new(width: W) -> Truncate<'static, W>

Creates a Truncate object

impl<'a, W, P> Truncate<'a, W, P>

pub fn suffix<S: Into<Cow<'a, str>>>(self, suffix: S) -> Truncate<'a, W, P>

Sets a suffix which will be appended to a resultant string.

The suffix is used in 3 circumstances: 1. If original string is bigger than the suffix. We cut more of the original string and append the suffix. 2. If suffix is bigger than the original string. We cut the suffix to fit in the width by default. But you can peak the behaviour by using Truncate::suffix_limit

pub fn suffix_limit(self, limit: SuffixLimit) -> Truncate<'a, W, P>

Sets a suffix limit, which is used when the suffix is too big to be used.

pub fn multiline(self, on: bool) -> Truncate<'a, W, P>

Use trancate logic per line, not as a string as a whole.

impl<'a, W, P> Truncate<'a, W, P>

pub fn priority<PP: Peaker>(self, priority: PP) -> Truncate<'a, W, PP>

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

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

impl Truncate<'_, (), ()>

pub fn truncate(text: &str, width: usize) -> Cow<'_, str>

Truncate a given string

Trait Implementations

impl<W, P, R> CellOption<R, ColoredConfig> for Truncate<'_, 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<'a, W: Clone, P: Clone> Clone for Truncate<'a, W, P>

fn clone(&self) -> Truncate<'a, W, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, W: Debug, P: Debug> Debug for Truncate<'a, W, P>

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

Formats the value using the given formatter.

impl<'a, W: Ord, P: Ord> Ord for Truncate<'a, W, P>

fn cmp(&self, other: &Truncate<'a, 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<'a, W: PartialEq, P: PartialEq> PartialEq for Truncate<'a, W, P>

fn eq(&self, other: &Truncate<'a, 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<'a, W: PartialOrd, P: PartialOrd> PartialOrd for Truncate<'a, W, P>

fn partial_cmp(&self, other: &Truncate<'a, 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 Truncate<'_, W, P>

where W: Measurement<Width>, P: Peaker, R: Records + ExactRecords + PeekableRecords + RecordsMut<String>, 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<'a, W: Eq, P: Eq> Eq for Truncate<'a, W, P>

impl<'a, W, P> StructuralPartialEq for Truncate<'a, W, P>