Struct Text

Source
pub struct Text {
    pub position: Point2<i16>,
    pub text: CString,
    pub font: Font,
    pub horizontal_align: HAlign,
    pub vertical_align: VAlign,
}
Expand description

A piece of text that can be drawn on the display.

Fields§

§position: Point2<i16>

Top left corner coordinates of text on the display

§text: CString

C-String of the desired text to be displayed on the display

§font: Font

The font that will be used when this text is displayed

§horizontal_align: HAlign

Horizontal alignment of text displayed on the display

§vertical_align: VAlign

Vertical alignment of text displayed on the display

Implementations§

Source§

impl Text

Source

pub fn new(text: &str, font: Font, position: impl Into<Point2<i16>>) -> Self

Create a new text with a given position (defaults to top left corner alignment) and font

Source

pub fn new_aligned( text: &str, font: Font, position: impl Into<Point2<i16>>, horizontal_align: HAlign, vertical_align: VAlign, ) -> Self

Create a new text with a given position (based on alignment) and font

Source

pub const fn align(&mut self, horizontal_align: HAlign, vertical_align: VAlign)

Change text alignment

Source

pub fn height(&self) -> u16

Returns the height of the text widget in pixels

Source

pub fn width(&self) -> u16

Returns the width of the text widget in pixels

Source§

impl Text

Source

pub fn draw( &self, _display: &mut Display, color: impl Into<Rgb<u8>>, bg_color: Option<Rgb<u8>>, )

Write the text to the display.

§Arguments
  • display - The display to write the text to.
  • color - The color of the text.
  • bg_color - The background color of the text. If None, the background will be transparent.

Trait Implementations§

Source§

impl Clone for Text

Source§

fn clone(&self) -> Text

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Text

Source§

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

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

impl PartialEq for Text

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 Eq for Text

Source§

impl StructuralPartialEq for Text

Auto Trait Implementations§

§

impl Freeze for Text

§

impl RefUnwindSafe for Text

§

impl Send for Text

§

impl Sync for Text

§

impl Unpin for Text

§

impl UnwindSafe for Text

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

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

Source§

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

Source§

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.