Skip to main content

StyleSheet

Struct StyleSheet 

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

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§

Source§

impl StyleSheet

Source

pub fn new() -> StyleSheet

Creates a style sheet with no colors and no attributes

Source

pub fn empty() -> StyleSheet

A stylesheet with no colors and no attributes.

Source

pub fn is_empty(&self) -> bool

Check if the stylesheet contains no colors and no attributes.

Source

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

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

Source

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

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

Source

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

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§

Source§

impl Clone for StyleSheet

Source§

fn clone(&self) -> StyleSheet

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 StyleSheet

Source§

impl Debug for StyleSheet

Source§

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

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

impl Default for StyleSheet

Source§

fn default() -> StyleSheet

A stylesheet with no colors and no attributes.

Source§

impl Eq for StyleSheet

Source§

impl PartialEq for StyleSheet

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StyleSheet

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more