Struct embedded_graphics::text::Text

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

Text drawable.

A text drawable can be used to draw text to a draw target.

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

Fields

text: &'a str

The string.

position: Point

The position.

character_style: S

The character style.

text_style: TextStyle

The text style.

Implementations

impl<'a, S> Text<'a, S>

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

Creates a text drawable with the default text style.

pub const fn with_text_style( text: &'a str, position: Point, character_style: S, text_style: TextStyle, ) -> Self

Creates a text drawable with the given text style.

pub const fn with_baseline( text: &'a str, position: Point, character_style: S, baseline: Baseline, ) -> Self

Creates a text drawable with the given baseline.

pub const fn with_alignment( text: &'a str, position: Point, character_style: S, alignment: Alignment, ) -> Self

Creates a text drawable with the given alignment.

Trait Implementations

impl<'a, S: Clone> Clone for Text<'a, S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for Text<'a, S>

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

Formats the value using the given formatter.

impl<S: TextRenderer> Dimensions for Text<'_, S>

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl<S: TextRenderer> Drawable for Text<'_, S>

type Color = <S as TextRenderer>::Color

The pixel color type.

type Output = Point

The return type of the draw method.

fn draw<D>(&self, target: &mut D) -> Result<Point, D::Error>

where D: DrawTarget<Color = Self::Color>,

Draw the graphics object using the supplied DrawTarget.

impl<'a, S: Hash> Hash for Text<'a, S>

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

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

Restrict a value to a certain interval.

impl<'a, S: PartialEq> PartialEq for Text<'a, S>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, S: PartialOrd> PartialOrd for Text<'a, S>

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

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

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

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

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

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

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

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

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<S: Clone> Transform for Text<'_, S>

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, S: Copy> Copy for Text<'a, S>

impl<'a, S: Eq> Eq for Text<'a, S>

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