Struct 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.

Implementations

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

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

Formats the value using the given formatter.

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, Self: Sized,

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.

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

fn eq(&self, other: &Text<'a>) -> 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<'a> PartialOrd 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: &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 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

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

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

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes