Struct inquire::ui::StyleSheet

pub struct StyleSheet {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub att: Attributes,
}

Style definitions that can be applied to the rendered content.

Example

use inquire::ui::{Attributes, Color, StyleSheet};

let style_sheet = StyleSheet::default();

assert!(style_sheet.is_empty());

let style_sheet = style_sheet
    .with_bg(Color::DarkBlue)
    .with_attr(Attributes::ITALIC | Attributes::BOLD);

assert!(!style_sheet.is_empty());

Fields

fg: Option<Color>

Foreground color of text.

bg: Option<Color>

Background color of text.

att: Attributes

Attributes applied to text.

Implementations

impl StyleSheet

pub fn new() -> Self

Creates a style sheet with no colors and no attributes

pub fn empty() -> Self

A stylesheet with no colors and no attributes.

pub fn is_empty(&self) -> bool

Check if the stylesheet contains no colors and no attributes.

pub fn with_fg(self, fg: Color) -> Self

Copies the StyleSheet to a new one set with the defined foreground Color.

pub fn with_bg(self, bg: Color) -> Self

Copies the StyleSheet to a new one set with the defined background Color.

pub fn with_attr(self, attributes: Attributes) -> Self

Copies the style sheet to a new one with the specified attributes.

Warning: this does not keep the previously applied attributes. If you want to just set a new attribute and keep the others, you need to apply the OR operation yourself.

Example

use inquire::ui::{Attributes, Color, StyleSheet};

let style_sheet = StyleSheet::default().with_attr(Attributes::BOLD);
assert_eq!(true,  style_sheet.att.contains(Attributes::BOLD));
assert_eq!(false, style_sheet.att.contains(Attributes::ITALIC));

let style_sheet = style_sheet.with_attr(Attributes::ITALIC);
assert_eq!(false, style_sheet.att.contains(Attributes::BOLD));
assert_eq!(true,  style_sheet.att.contains(Attributes::ITALIC));

let style_sheet = style_sheet.with_attr(style_sheet.att | Attributes::BOLD);
assert_eq!(true, style_sheet.att.contains(Attributes::BOLD));
assert_eq!(true, style_sheet.att.contains(Attributes::ITALIC));

Trait Implementations

impl Clone for StyleSheet

fn clone(&self) -> StyleSheet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StyleSheet

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

Formats the value using the given formatter.

impl Default for StyleSheet

fn default() -> Self

A stylesheet with no colors and no attributes.

impl From<StyleSheet> for Style

Available on crate feature console only.

fn from(from: StyleSheet) -> Self

Converts to this type from the input type.

impl Hash for StyleSheet

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 PartialEq for StyleSheet

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

impl Eq for StyleSheet

impl StructuralPartialEq for StyleSheet