Struct BorderText

pub struct BorderText<'a> { /* private fields */ }

BorderText writes a custom text on a border.

Example

use tabled::{Table, BorderText};

let mut table = Table::new(["Hello World"]);
table
    .with(BorderText::first("+-.table"));

assert_eq!(
    table.to_string(),
    "+-.table------+\n\
     | &str        |\n\
     +-------------+\n\
     | Hello World |\n\
     +-------------+"
);

Implementations

impl<'a> BorderText<'a>

pub fn new<S>(line: usize, text: S) -> Self

where S: Into<Cow<'a, str>>,

Creates a BorderText instance.

Lines are numbered from 0 to the count_rows included (line >= 0 && line <= count_rows).

pub fn first<S>(text: S) -> Self

where S: Into<Cow<'a, str>>,

Creates a BorderText instance for a top line.

pub fn last<S>(text: S) -> Self

where S: Into<Cow<'a, str>>,

Creates a BorderText instance for a bottom line.

pub fn offset(self, offset: Offset) -> Self

Set an offset from which the text will be started.

Trait Implementations

impl<'a> Debug for BorderText<'a>

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

Formats the value using the given formatter.

impl<'a, R> TableOption<R> for BorderText<'a>

where R: Records,

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

The function modifies a Grid object.