Struct embedded_graphics::text::TextStyle

#[non_exhaustive]
pub struct TextStyle {
    pub alignment: Alignment,
    pub baseline: Baseline,
    pub line_height: LineHeight,
}

Text style.

A text style is used to set how text lines are laid out in a text drawable.

Use TextStyleBuilder to build a text style object.

See the module-level documentation for more information about text styles and examples.

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.

alignment: Alignment

Horizontal text alignment.

baseline: Baseline

Text baseline.

line_height: LineHeight

Line height.

Implementations

impl TextStyle

pub const fn with_baseline(baseline: Baseline) -> Self

Creates a new text style with the given baseline.

pub const fn with_alignment(alignment: Alignment) -> Self

Creates a new text style with the given alignment.

Trait Implementations

impl Clone for TextStyle

fn clone(&self) -> TextStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextStyle

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

Formats the value using the given formatter.

impl Default for TextStyle

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ TextStyle> for TextStyleBuilder

fn from(style: &TextStyle) -> Self

Performs the conversion.

impl Hash for TextStyle

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 Ord for TextStyle

fn cmp(&self, other: &TextStyle) -> 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

Restrict a value to a certain interval.

impl PartialEq<TextStyle> for TextStyle

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

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

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

This method tests for !=.

impl PartialOrd<TextStyle> for TextStyle

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Copy for TextStyle

impl Eq for TextStyle

impl StructuralEq for TextStyle

impl StructuralPartialEq for TextStyle