Struct Wrap

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

Wrap wraps a string to a new line in case it exceeds the provided max boundary. 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::Width, Modify}};

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

Implementations

impl<W> Wrap<W>

pub fn new(width: W) -> Self

where W: Measurement<Width>,

Creates a Wrap object

impl<W, P> Wrap<W, P>

pub fn priority<PP: Peaker>(self, priority: PP) -> Wrap<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.

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.

pub fn keep_words(self, on: bool) -> Self

Set the keep words option.

If a wrapping point will be in a word, Wrap will preserve a word (if possible) and wrap the string before it.

impl Wrap<(), ()>

pub fn wrap(text: &str, width: usize, keeping_words: bool) -> String

Wrap a given string

Trait Implementations

impl<W, R, P> CellOption<R, ColoredConfig> for Wrap<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 Wrap<W, P>

fn clone(&self) -> Wrap<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 Wrap<W, P>

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

Formats the value using the given formatter.

impl<W, P, R> TableOption<R, ColoredConfig, CompleteDimension> for Wrap<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.