Struct Alignment

pub struct Alignment { /* private fields */ }

Alignment represent a horizontal and vertical alignment setting for any cell on a Table.

An alignment strategy can be set by AlignmentStrategy.

Example

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

let data = [
    ["1", "2", "3"],
    ["Some\nMulti\nLine\nText", "and a line", "here"],
    ["4", "5", "6"],
];

let mut table = Table::new(&data);
table
    .with(Style::modern())
    .with(
        Modify::new(Segment::all())
            .with(Alignment::right())
            .with(Alignment::center())
            .with(AlignmentStrategy::PerCell)
    );

assert_eq!(
    table.to_string(),
    concat!(
        "┌───────┬────────────┬──────┐\n",
        "│   0   │     1      │  2   │\n",
        "├───────┼────────────┼──────┤\n",
        "│   1   │     2      │  3   │\n",
        "├───────┼────────────┼──────┤\n",
        "│ Some  │ and a line │ here │\n",
        "│ Multi │            │      │\n",
        "│ Line  │            │      │\n",
        "│ Text  │            │      │\n",
        "├───────┼────────────┼──────┤\n",
        "│   4   │     5      │  6   │\n",
        "└───────┴────────────┴──────┘",
    ),
)

Implementations

impl Alignment

pub const fn left() -> Self

Left constructs a horizontal alignment to AlignmentHorizontal::Left

pub const fn right() -> Self

Right constructs a horizontal alignment to AlignmentHorizontal::Right

Notice

When you use MinWidth the alignment might not work as you expected. You could try to apply TrimStrategy which may help.

pub const fn center() -> Self

Center constructs a horizontal alignment to AlignmentHorizontal::Center

Notice

When you use MinWidth the alignment might not work as you expected. You could try to apply TrimStrategy which may help.

pub const fn top() -> Self

Top constructs a vertical alignment to AlignmentVertical::Top

pub const fn bottom() -> Self

Bottom constructs a vertical alignment to AlignmentVertical::Bottom

pub const fn center_vertical() -> Self

Center_vertical constructs a vertical alignment to AlignmentVertical::Center

pub const fn as_horizontal(self) -> Option<AlignmentHorizontal>

Convert alignment to horizontal.

pub const fn as_vertical(self) -> Option<AlignmentVertical>

Convert alignment to vertical.

Trait Implementations

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

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 Alignment

fn clone(&self) -> Alignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Alignment

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

Formats the value using the given formatter.

impl From<Alignment> for Option<AlignmentHorizontal>

fn from(value: Alignment) -> Self

Converts to this type from the input type.

impl From<Alignment> for Option<AlignmentVertical>

fn from(value: Alignment) -> Self

Converts to this type from the input type.

impl From<AlignmentHorizontal> for Alignment

fn from(value: AlignmentHorizontal) -> Self

Converts to this type from the input type.

impl From<AlignmentVertical> for Alignment

fn from(value: AlignmentVertical) -> Self

Converts to this type from the input type.

impl Hash for Alignment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Alignment

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

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

fn partial_cmp(&self, other: &Alignment) -> 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 Alignment

fn change(self, _: &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<R, D> TableOption<R, CompactConfig, D> for Alignment

fn change(self, _: &mut R, cfg: &mut CompactConfig, _: &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<R, D> TableOption<R, CompactMultilineConfig, D> for Alignment

fn change(self, _: &mut R, cfg: &mut CompactMultilineConfig, _: &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 Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment