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::{object::Segment, Width, Modify, Table};

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

Implementations

impl<W> Wrap<W>

where W: Measurment<Width>,

pub fn new(width: W) -> Self

Creates a Wrap object

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

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

Trait Implementations

impl<W, P, R> CellOption<R> for Wrap<W, P>

where W: Measurment<Width>, R: Records + RecordsMut<String>,

fn change_cell(&mut self, table: &mut Table<R>, entity: Entity)

Modification function of a single cell.

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

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

Returns a copy 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> for Wrap<W, P>

where W: Measurment<Width>, P: Peaker, R: Records + RecordsMut<String>,

fn change(&mut self, table: &mut Table<R>)

The function modifies a Grid object.