Struct Modify

pub struct Modify<O> { /* private fields */ }

Modify structure provide an abstraction, to be able to apply a set of CellOptions to the same object.

Be aware that the settings are applied all to a cell at a time. So sometimes you may need to make a several calls of Modify in order to achieve the desired affect.

Implementations

impl<O> Modify<O>

pub const fn new(obj: O) -> Self

Creates a new Modify without any options.

pub const fn list<M>(obj: O, next: M) -> ModifyList<O, M>

A function which combines together Modify::new and Modify::with calls.

use tabled::{Table, settings::{Modify, Padding, object::Rows}};

let table = Table::new(&["Year", "2021"])
    .with(Modify::list(Rows::first(), Padding::new(1, 1, 1, 1)))
    .to_string();

assert_eq!(
    table,
    "+------+\n\
     |      |\n\
     | &str |\n\
     |      |\n\
     +------+\n\
     | Year |\n\
     +------+\n\
     | 2021 |\n\
     +------+"
)

pub fn with<M>(self, next: M) -> ModifyList<O, M>

It’s a generic function which stores a CellOption.

IMPORTANT: The function doesn’t changes a Table. Table will be changed only after passing Modify object to Table::with.

use tabled::{Table, settings::{Modify, Padding, object::Rows}};

let table = Table::new(&["Year", "2021"])
    .with(Modify::new(Rows::first()).with(Padding::new(1, 1, 1, 1)))
    .to_string();

assert_eq!(
    table,
    "+------+\n\
     |      |\n\
     | &str |\n\
     |      |\n\
     +------+\n\
     | Year |\n\
     +------+\n\
     | 2021 |\n\
     +------+"
)

Trait Implementations

impl<O: Clone> Clone for Modify<O>

fn clone(&self) -> Modify<O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for Modify<O>

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

Formats the value using the given formatter.

impl<O: Ord> Ord for Modify<O>

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

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

fn partial_cmp(&self, other: &Modify<O>) -> 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<O: Copy> Copy for Modify<O>

impl<O: Eq> Eq for Modify<O>

impl<O> StructuralPartialEq for Modify<O>