Struct gemini_engine::elements::ascii::Text

#[non_exhaustive]
pub struct Text<'a> {
    pub pos: Vec2D,
    pub content: &'a str,
    pub align: TextAlign,
    pub modifier: Modifier,
}

Displays text at the given position

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.

pos: Vec2D

content: &'a str

The actual text content of the element

align: TextAlign

How the content should align to the position

modifier: Modifier

A raw Modifier, determining the appearance of the Text

Implementations

impl<'a> Text<'a>

pub fn new(pos: Vec2D, content: &str, modifier: Modifier) -> Text<'_>

Create a new Text element with a position, content and modifier

Panics

This function will panic if the content contains a newline, as Text only works with single lines. For multi-line strings, see Sprite

pub fn with_align( pos: Vec2D, content: &str, align: TextAlign, modifier: Modifier ) -> Text<'_>

Create a Text element with an align parameter to set the Text’s align (see the TextAlign documentation)

Panics

This function will panic if the content contains a newline, as Text only works with single lines. For multi-line strings, see Sprite

Examples found in repository

examples/self-resizing.rs (lines 11-16)

fn main() {
    let mut view = View::new(100, 100, ColChar::BACKGROUND).with_block_until_resized(true);
    let mut text = Text::with_align(
        view.center(),
        "This is some centered text!",
        TextAlign::Centered,
        Modifier::None,
    );

    loop {
        let terminal_size = termsize::get().unwrap();
        view.width = terminal_size.cols as usize;
        view.height = terminal_size.rows as usize - 2;

        text.pos = view.center();

        view.clear();
        view.blit(&text, Wrapping::Wrap);
        view.display_render().unwrap();

        sleep(Duration::from_millis(10))
    }
}

pub fn draw(pos: Vec2D, content: &str, modifier: Modifier) -> Vec<Pixel>

Return a vector of Pixels to display the given content

pub fn draw_with_align( pos: Vec2D, content: &str, align: TextAlign, modifier: Modifier ) -> Vec<Pixel>

Return a vector of Pixels to display the given content, aligning the content to the position as directed by the align attribute

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 ViewElement for Text<'_>

fn active_pixels(&self) -> Vec<Pixel>

Return a vector of the element’s Pixels - A ColChar. If your whole object is a solid colour, consider using utils::points_to_pixels() which will add the same ColChar to every point and can then be used as this function’s output

fn active_points(&self) -> Vec<Vec2D>

Return the positions the ViewElement occupies, essentially active_pixels() without the ColChars. This has a default setting that extracts the Vec2Ds from active_pixels but you can set it to something else to make it faster