Struct embedded_graphics::mono_font::MonoTextStyle

source ·
#[non_exhaustive]
pub struct MonoTextStyle<'a, C> { pub text_color: Option<C>, pub background_color: Option<C>, pub underline_color: DecorationColor<C>, pub strikethrough_color: DecorationColor<C>, pub font: &'a MonoFont<'a>, }
Expand description

Style properties for text using a monospaced font.

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

Because MonoTextStyle has the non_exhaustive attribute, it cannot be created using a struct literal. To create a MonoTextStyle with a given text color and transparent background, use the new method. For more complex text styles, use the MonoTextStyleBuilder.

Fields (Non-exhaustive)§

This struct is marked as 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.

§underline_color: DecorationColor<C>

Underline color.

§strikethrough_color: DecorationColor<C>

Strikethrough color.

§font: &'a MonoFont<'a>

Font.

Implementations§

source§

impl<'a, C: PixelColor> MonoTextStyle<'a, C>

source

pub fn new(font: &'a MonoFont<'a>, text_color: C) -> Self

Creates a text style with transparent background.

source

pub fn is_transparent(&self) -> bool

Returns true if the style is transparent.

Drawing a Text with a transparent MonoTextStyle will not draw any pixels.

Trait Implementations§

source§

impl<C: PixelColor> CharacterStyle for MonoTextStyle<'_, C>

§

type Color = C

The color type.
source§

fn set_text_color(&mut self, text_color: Option<Self::Color>)

Sets the text color.
source§

fn set_background_color(&mut self, background_color: Option<Self::Color>)

Sets the background color.
source§

fn set_underline_color(&mut self, underline_color: DecorationColor<Self::Color>)

Sets the underline color.
source§

fn set_strikethrough_color( &mut self, strikethrough_color: DecorationColor<Self::Color>, )

Sets the strikethrough color.
source§

impl<'a, C: Clone> Clone for MonoTextStyle<'a, C>

source§

fn clone(&self) -> MonoTextStyle<'a, C>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a, C: Debug> Debug for MonoTextStyle<'a, C>

source§

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

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

impl<'a, C: PixelColor> From<&MonoTextStyle<'a, C>> for MonoTextStyleBuilder<'a, C>

source§

fn from(style: &MonoTextStyle<'a, C>) -> Self

Converts to this type from the input type.
source§

impl<'a, C: PartialEq> PartialEq for MonoTextStyle<'a, C>

source§

fn eq(&self, other: &MonoTextStyle<'a, C>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<C: PixelColor> TextRenderer for MonoTextStyle<'_, C>

§

type Color = C

Color type.
source§

fn draw_string<D>( &self, text: &str, position: Point, baseline: Baseline, target: &mut D, ) -> Result<Point, D::Error>
where D: DrawTarget<Color = Self::Color>,

Draws a string. Read more
source§

fn draw_whitespace<D>( &self, width: u32, position: Point, baseline: Baseline, target: &mut D, ) -> Result<Point, D::Error>
where D: DrawTarget<Color = Self::Color>,

Draws whitespace of the given width. Read more
source§

fn measure_string( &self, text: &str, position: Point, baseline: Baseline, ) -> TextMetrics

Returns the text metrics for a string. Read more
source§

fn line_height(&self) -> u32

Returns the default line height. Read more
source§

impl<'a, C: Copy> Copy for MonoTextStyle<'a, C>

source§

impl<'a, C> StructuralPartialEq for MonoTextStyle<'a, C>

Auto Trait Implementations§

§

impl<'a, C> Freeze for MonoTextStyle<'a, C>
where C: Freeze,

§

impl<'a, C> !RefUnwindSafe for MonoTextStyle<'a, C>

§

impl<'a, C> !Send for MonoTextStyle<'a, C>

§

impl<'a, C> !Sync for MonoTextStyle<'a, C>

§

impl<'a, C> Unpin for MonoTextStyle<'a, C>
where C: Unpin,

§

impl<'a, C> !UnwindSafe for MonoTextStyle<'a, C>

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> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.