Skip to main content

TableStyle

Struct TableStyle 

Source
pub struct TableStyle {
    pub top_border: LineStyle,
    pub header_lines: ContentLineStyle,
    pub header_separator: LineStyle,
    pub content_lines: ContentLineStyle,
    pub row_separator: LineStyle,
    pub bottom_border: LineStyle,
}
Expand description

The full description of a table’s look, built from four horizontal LineStyles and two ContentLineStyles:

┌─────────┬─────────┐   <- top_border
│ Hello   ┆ there   │   <- header_lines
╞═════════╪═════════╡   <- header_separator
│ a       ┆ b       │   <- content_lines
├╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤   <- row_separator
│ c       ┆ d       │
└─────────┴─────────┘   <- bottom_border

All functions for building a style are const, so custom styles can be declared as constants, just like the ones in the presets module:

use comfy_table::{ContentLineStyle, LineStyle, Table, TableStyle};

const MY_STYLE: TableStyle = TableStyle::new()
    .top_border(LineStyle::new('┌', '─', '┬', '┐'))
    .header_lines(ContentLineStyle::new('│', '┆', '│'))
    .header_separator(LineStyle::new('╞', '═', '╪', '╡'))
    .content_lines(ContentLineStyle::new('│', '┆', '│'))
    .bottom_border(LineStyle::new('└', '─', '┴', '┘'));

let mut table = Table::new();
table.load_style(MY_STYLE);

Fields§

§top_border: LineStyle§header_lines: ContentLineStyle§header_separator: LineStyle§content_lines: ContentLineStyle§row_separator: LineStyle§bottom_border: LineStyle

Implementations§

Source§

impl TableStyle

Source

pub const fn new() -> Self

Create a style that doesn’t draw anything.

Source

pub const fn top_border(self, line: LineStyle) -> Self

Set the top border of the table.

Source

pub const fn header_lines(self, line: ContentLineStyle) -> Self

Set the style of the lines that contain the header’s content.

Source

pub const fn header_separator(self, line: LineStyle) -> Self

Set the line that’s drawn between the header and the first row.

Source

pub const fn content_lines(self, line: ContentLineStyle) -> Self

Set the style of the lines that contain the rows’ content.

Source

pub const fn row_separator(self, line: LineStyle) -> Self

Set the line that’s drawn between rows.

Source

pub const fn bottom_border(self, line: LineStyle) -> Self

Set the bottom border of the table.

Source

pub const fn with_rounded_corners(self) -> Self

Convert the outer corners to round corners.

╭───────┬───────╮
│ Hello │ there │
╞═══════╪═══════╡
│ a     ┆ b     │
├╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┤
│ c     ┆ d     │
╰───────┴───────╯
Source

pub const fn with_solid_inner_borders(self) -> Self

Convert the inner borders to solid lines.

┌───────┬───────┐
│ Hello │ there │
╞═══════╪═══════╡
│ a     │ b     │
├───────┼───────┤
│ c     │ d     │
└───────┴───────┘

Trait Implementations§

Source§

impl Clone for TableStyle

Source§

fn clone(&self) -> TableStyle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TableStyle

Source§

impl Debug for TableStyle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableStyle

Source§

fn default() -> TableStyle

Returns the “default value” for a type. Read more
Source§

impl Eq for TableStyle

Source§

impl PartialEq for TableStyle

Source§

fn eq(&self, other: &TableStyle) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TableStyle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.