Struct crossterm::style::ContentStyle

pub struct ContentStyle {
    pub foreground_color: Option<Color>,
    pub background_color: Option<Color>,
    pub underline_color: Option<Color>,
    pub attributes: Attributes,
}

The style that can be put on content.

Fields

foreground_color: Option<Color>

The foreground color.

background_color: Option<Color>

The background color.

underline_color: Option<Color>

The underline color.

attributes: Attributes

List of attributes.

Implementations

impl ContentStyle

pub fn apply<D: Display>(self, val: D) -> StyledContent<D>

Creates a StyledContent by applying the style to the given val.

pub fn new() -> ContentStyle

Creates a new ContentStyle.

Trait Implementations

impl AsMut<ContentStyle> for ContentStyle

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.

impl<D: Display> AsMut<ContentStyle> for StyledContent<D>

fn as_mut(&mut self) -> &mut ContentStyle

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<ContentStyle> for ContentStyle

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl<D: Display> AsRef<ContentStyle> for StyledContent<D>

fn as_ref(&self) -> &ContentStyle

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ContentStyle

fn clone(&self) -> ContentStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentStyle

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

Formats the value using the given formatter.

impl Default for ContentStyle

fn default() -> ContentStyle

Returns the “default value” for a type.

impl PartialEq for ContentStyle

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Stylize for ContentStyle

type Styled = ContentStyle

This type with styles applied.

fn stylize(self) -> Self::Styled

Styles this type.

fn with(self, color: Color) -> Self::Styled

Sets the foreground color.

fn on(self, color: Color) -> Self::Styled

Sets the background color.

fn underline(self, color: Color) -> Self::Styled

Sets the underline color.

fn attribute(self, attr: Attribute) -> Self::Styled

Styles the content with the attribute.

fn reset(self) -> Self::Styled

Applies the Reset attribute to the text.

fn bold(self) -> Self::Styled

Applies the Bold attribute to the text.

fn underlined(self) -> Self::Styled

Applies the Underlined attribute to the text.

fn reverse(self) -> Self::Styled

Applies the Reverse attribute to the text.

fn dim(self) -> Self::Styled

Applies the Dim attribute to the text.

fn italic(self) -> Self::Styled

Applies the Italic attribute to the text.

fn negative(self) -> Self::Styled

Applies the Reverse attribute to the text.

fn slow_blink(self) -> Self::Styled

Applies the SlowBlink attribute to the text.

fn rapid_blink(self) -> Self::Styled

Applies the RapidBlink attribute to the text.

fn hidden(self) -> Self::Styled

Applies the Hidden attribute to the text.

fn crossed_out(self) -> Self::Styled

Applies the CrossedOut attribute to the text.

fn black(self) -> Self::Styled

Sets the foreground color to Black.

fn on_black(self) -> Self::Styled

Sets the background color to Black.

fn underline_black(self) -> Self::Styled

Sets the underline color to Black.

fn dark_grey(self) -> Self::Styled

Sets the foreground color to DarkGrey.

fn on_dark_grey(self) -> Self::Styled

Sets the background color to DarkGrey.

fn underline_dark_grey(self) -> Self::Styled

Sets the underline color to DarkGrey.

fn red(self) -> Self::Styled

Sets the foreground color to Red.

fn on_red(self) -> Self::Styled

Sets the background color to Red.

fn underline_red(self) -> Self::Styled

Sets the underline color to Red.

fn dark_red(self) -> Self::Styled

Sets the foreground color to DarkRed.

fn on_dark_red(self) -> Self::Styled

Sets the background color to DarkRed.

fn underline_dark_red(self) -> Self::Styled

Sets the underline color to DarkRed.

fn green(self) -> Self::Styled

Sets the foreground color to Green.

fn on_green(self) -> Self::Styled

Sets the background color to Green.

fn underline_green(self) -> Self::Styled

Sets the underline color to Green.

fn dark_green(self) -> Self::Styled

Sets the foreground color to DarkGreen.

fn on_dark_green(self) -> Self::Styled

Sets the background color to DarkGreen.

fn underline_dark_green(self) -> Self::Styled

Sets the underline color to DarkGreen.

fn yellow(self) -> Self::Styled

Sets the foreground color to Yellow.

fn on_yellow(self) -> Self::Styled

Sets the background color to Yellow.

fn underline_yellow(self) -> Self::Styled

Sets the underline color to Yellow.

fn dark_yellow(self) -> Self::Styled

Sets the foreground color to DarkYellow.

fn on_dark_yellow(self) -> Self::Styled

Sets the background color to DarkYellow.

fn underline_dark_yellow(self) -> Self::Styled

Sets the underline color to DarkYellow.

fn blue(self) -> Self::Styled

Sets the foreground color to Blue.

fn on_blue(self) -> Self::Styled

Sets the background color to Blue.

fn underline_blue(self) -> Self::Styled

Sets the underline color to Blue.

fn dark_blue(self) -> Self::Styled

Sets the foreground color to DarkBlue.

fn on_dark_blue(self) -> Self::Styled

Sets the background color to DarkBlue.

fn underline_dark_blue(self) -> Self::Styled

Sets the underline color to DarkBlue.

fn magenta(self) -> Self::Styled

Sets the foreground color to Magenta.

fn on_magenta(self) -> Self::Styled

Sets the background color to Magenta.

fn underline_magenta(self) -> Self::Styled

Sets the underline color to Magenta.

fn dark_magenta(self) -> Self::Styled

Sets the foreground color to DarkMagenta.

fn on_dark_magenta(self) -> Self::Styled

Sets the background color to DarkMagenta.

fn underline_dark_magenta(self) -> Self::Styled

Sets the underline color to DarkMagenta.

fn cyan(self) -> Self::Styled

Sets the foreground color to Cyan.

fn on_cyan(self) -> Self::Styled

Sets the background color to Cyan.

fn underline_cyan(self) -> Self::Styled

Sets the underline color to Cyan.

fn dark_cyan(self) -> Self::Styled

Sets the foreground color to DarkCyan.

fn on_dark_cyan(self) -> Self::Styled

Sets the background color to DarkCyan.

fn underline_dark_cyan(self) -> Self::Styled

Sets the underline color to DarkCyan.

fn white(self) -> Self::Styled

Sets the foreground color to White.

fn on_white(self) -> Self::Styled

Sets the background color to White.

fn underline_white(self) -> Self::Styled

Sets the underline color to White.

fn grey(self) -> Self::Styled

Sets the foreground color to Grey.

fn on_grey(self) -> Self::Styled

Sets the background color to Grey.

fn underline_grey(self) -> Self::Styled

Sets the underline color to Grey.

impl Copy for ContentStyle

impl Eq for ContentStyle

impl StructuralPartialEq for ContentStyle