StyleOpt

Struct StyleOpt 

Source
pub struct StyleOpt {
    pub fg: Option<Fg>,
    pub bg: Option<Bg>,
    pub sgr: Option<Sgr>,
}
Expand description

A struct providing optional customization of the foreground color, background color, and text style of a GridPrinter column.

Fields§

§fg: Option<Fg>§bg: Option<Bg>§sgr: Option<Sgr>

Implementations§

Source§

impl StyleOpt

Source

pub fn new() -> Self

Create a new StyleOpt with no specified style options.

Examples found in repository?
examples/colors.rs (line 17)
5fn main() -> Result<(), Box<dyn Error>> {
6
7    let grid = vec![
8        vec![1, 2, 3, 4, ],
9        vec![5, 6, 7, 8, ],
10        vec![9, 10, 11, 12, ],
11    ];
12
13    let rows = grid.len();
14    let cols = grid[0].len();
15    
16    let printer = GridPrinter::builder(rows, cols)
17        .col_style(0, StyleOpt::new().fg(Fg::Magenta))?
18        .col_style(1, StyleOpt::new().fg(Fg::Black).bg(Bg::BrightYellow))?
19        .col_style(2, StyleOpt::new().sgr(Sgr::StrikeThrough))?
20        .col_style(3, StyleOpt::new().fg(Fg::Cyan))?
21        .build();
22    printer.print(&grid);
23
24    Ok(())
25}
Source

pub fn fg(self, fg: Fg) -> Self

Set the foreground color.

Examples found in repository?
examples/colors.rs (line 17)
5fn main() -> Result<(), Box<dyn Error>> {
6
7    let grid = vec![
8        vec![1, 2, 3, 4, ],
9        vec![5, 6, 7, 8, ],
10        vec![9, 10, 11, 12, ],
11    ];
12
13    let rows = grid.len();
14    let cols = grid[0].len();
15    
16    let printer = GridPrinter::builder(rows, cols)
17        .col_style(0, StyleOpt::new().fg(Fg::Magenta))?
18        .col_style(1, StyleOpt::new().fg(Fg::Black).bg(Bg::BrightYellow))?
19        .col_style(2, StyleOpt::new().sgr(Sgr::StrikeThrough))?
20        .col_style(3, StyleOpt::new().fg(Fg::Cyan))?
21        .build();
22    printer.print(&grid);
23
24    Ok(())
25}
Source

pub fn bg(self, bg: Bg) -> Self

Set the background color.

Examples found in repository?
examples/colors.rs (line 18)
5fn main() -> Result<(), Box<dyn Error>> {
6
7    let grid = vec![
8        vec![1, 2, 3, 4, ],
9        vec![5, 6, 7, 8, ],
10        vec![9, 10, 11, 12, ],
11    ];
12
13    let rows = grid.len();
14    let cols = grid[0].len();
15    
16    let printer = GridPrinter::builder(rows, cols)
17        .col_style(0, StyleOpt::new().fg(Fg::Magenta))?
18        .col_style(1, StyleOpt::new().fg(Fg::Black).bg(Bg::BrightYellow))?
19        .col_style(2, StyleOpt::new().sgr(Sgr::StrikeThrough))?
20        .col_style(3, StyleOpt::new().fg(Fg::Cyan))?
21        .build();
22    printer.print(&grid);
23
24    Ok(())
25}
Source

pub fn sgr(self, sgr: Sgr) -> Self

Set the Select Graphic Rendition.

Examples found in repository?
examples/colors.rs (line 19)
5fn main() -> Result<(), Box<dyn Error>> {
6
7    let grid = vec![
8        vec![1, 2, 3, 4, ],
9        vec![5, 6, 7, 8, ],
10        vec![9, 10, 11, 12, ],
11    ];
12
13    let rows = grid.len();
14    let cols = grid[0].len();
15    
16    let printer = GridPrinter::builder(rows, cols)
17        .col_style(0, StyleOpt::new().fg(Fg::Magenta))?
18        .col_style(1, StyleOpt::new().fg(Fg::Black).bg(Bg::BrightYellow))?
19        .col_style(2, StyleOpt::new().sgr(Sgr::StrikeThrough))?
20        .col_style(3, StyleOpt::new().fg(Fg::Cyan))?
21        .build();
22    printer.print(&grid);
23
24    Ok(())
25}

Trait Implementations§

Source§

impl Clone for StyleOpt

Source§

fn clone(&self) -> StyleOpt

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StyleOpt

Source§

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

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

impl Default for StyleOpt

Source§

fn default() -> StyleOpt

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

impl PartialEq for StyleOpt

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for StyleOpt

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.