Struct embedded_graphics::fonts::Text

pub struct Text<'a> {
    pub text: &'a str,
    pub position: Point,
}

A text object.

The Text struct represents a string that can be drawn onto a display.

The text object only contains the string and position and no additional styling information, like the font or color. To draw a text object it is necessary to attach a style to it by using the into_styled method to create a Styled object.

See the module-level documentation for examples how to use text objects.

Fields

text: &'a str

The string.

position: Point

The position.

Defines the top-left starting pixel of the text object.

Methods

impl<'a> Text<'a>

pub const fn new(text: &'a str, position: Point) -> Self

Creates a text.

pub fn into_styled<C, F>(
    self,
    style: TextStyle<C, F>
) -> Styled<Self, TextStyle<C, F>> where
    C: PixelColor,
    F: Font, 

Attaches a text style to the text object.

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Text<'a>

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Text<'a>

impl<'a> Hash for Text<'a>

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<'a> Ord for Text<'a>

fn cmp(&self, other: &Text<'a>) -> 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<'a> PartialEq<Text<'a>> for Text<'a>

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

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

fn ne(&self, other: &Text<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Text<'a>> for Text<'a>

fn partial_cmp(&self, other: &Text<'a>) -> Option<Ordering>

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

fn lt(&self, other: &Text<'a>) -> bool

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

fn le(&self, other: &Text<'a>) -> bool

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

fn gt(&self, other: &Text<'a>) -> bool

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

fn ge(&self, other: &Text<'a>) -> bool

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

impl<'a> StructuralEq for Text<'a>

impl<'a> StructuralPartialEq for Text<'a>

impl<'_> Transform for Text<'_>

fn translate(&self, by: Point) -> Self

Move the origin of an object by a given number of (x, y) pixels, returning a new object

fn translate_mut(&mut self, by: Point) -> &mut Self

Move the origin of an object by a given number of (x, y) pixels, mutating the object in place