Struct embedded_graphics::style::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.

Methods

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: Clone, F: Clone> Clone for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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: Copy, F: Copy> Copy for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

impl<C: Debug, F: Debug> Debug for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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

Formats the value using the given formatter.

impl<C: Default, F: Default> Default for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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

Returns the "default value" for a type.

impl<C: Eq, F: Eq> Eq for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

impl<C: Hash, F: Hash> Hash for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<C: Ord, F: Ord> Ord for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<C: PartialEq, F: PartialEq> PartialEq<TextStyle<C, F>> for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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

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

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

This method tests for !=.

impl<C: PartialOrd, F: PartialOrd> PartialOrd<TextStyle<C, F>> for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

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: &TextStyle<C, F>) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<C, F> StructuralEq for TextStyle<C, F> where
    C: PixelColor,
    F: Font, 

impl<C, F> StructuralPartialEq for TextStyle<C, F> where
    C: PixelColor,
    F: Font,