Struct TextStyle

#[non_exhaustive]
pub struct TextStyle<C, F>
where
    C: PixelColor,
    F: Font,
{
    pub text_color: Option<C>,
    pub background_color: Option<C>,
    pub font: F,
}

Style properties for text.

A TextStyle can be applied to a Text object to define how the text is drawn.

Because TextStyle has the non_exhaustive attribute, it cannot be created using a struct literal. To create a TextStyle, use the text_style! macro or TextStyleBuilder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text_color: Option<C>

Text color.

background_color: Option<C>

Background color.

font: F

Font.

Implementations

impl<C, F> TextStyle<C, F>

where C: PixelColor, F: Font,

pub fn new(font: F, text_color: C) -> Self

Creates a text style with transparent background.

Trait Implementations

impl<C, F> Clone for TextStyle<C, F>

where C: PixelColor + Clone, F: Font + Clone,

fn clone(&self) -> TextStyle<C, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, F> Debug for TextStyle<C, F>

where C: PixelColor + Debug, F: Font + Debug,

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

Formats the value using the given formatter.

impl<C, F> Default for TextStyle<C, F>

where C: PixelColor + Default, F: Font + Default,

fn default() -> TextStyle<C, F>

Returns the “default value” for a type.

impl<C, F> Hash for TextStyle<C, F>

where C: PixelColor + Hash, F: Font + Hash,

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<C, F> Ord for TextStyle<C, F>

where C: PixelColor + Ord, F: Font + Ord,

fn cmp(&self, other: &TextStyle<C, F>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<C, F> PartialEq for TextStyle<C, F>

where C: PixelColor + PartialEq, F: Font + PartialEq,

fn eq(&self, other: &TextStyle<C, F>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<C, F> PartialOrd for TextStyle<C, F>

where C: PixelColor + PartialOrd, F: Font + PartialOrd,

fn partial_cmp(&self, other: &TextStyle<C, F>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C, F> Copy for TextStyle<C, F>

where C: PixelColor + Copy, F: Font + Copy,

impl<C, F> Eq for TextStyle<C, F>

where C: PixelColor + Eq, F: Font + Eq,

impl<C, F> StructuralPartialEq for TextStyle<C, F>

where C: PixelColor, F: Font,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.