Struct FontString 

pub struct FontString(/* private fields */);

A FontString is a collection of FontUnicode which can be rendered to frames for the LED Matrix.

Implementations

impl FontString

pub fn new() -> Self

Create an empty FontString.

pub fn chars(&self) -> Vec<char>

Render the font string as a collection of unicode value points, Vec<char>.

Examples found in repository

examples/letter.rs (line 25)

fn main() {
    let mut screen = Screen::open("/dev/fb1").unwrap();

    let white_50_pct = PixelColor::WHITE.dim(0.5);

    let letter = "Dear Toño, I am well. Thank you. Bye. - ゆにち";

    let screen_text = FONT_COLLECTION.sanitize_str(letter).unwrap();

    for unicode in screen_text.chars() {
        if let Some(symbol) = FONT_COLLECTION.get(unicode) {
            let frame = font_to_frame(symbol.byte_array(), white_50_pct);
            screen.write_frame(&frame);
        }
        thread::sleep(Duration::from_millis(800));
    }
}

pub fn font_frames(&self, stroke: PixelColor, bg: PixelColor) -> Vec<FontFrame>

Returns a Vec<FontFrame> for each inner font.

pub fn pixel_frames( &self, stroke: PixelColor, bg: PixelColor, ) -> Vec<PixelFrame>

Returns a Vec<PixelFrame> for each inner font.

Examples found in repository

examples/scroll-bottom-top.rs (line 23)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" ^^^123^^^ ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of CYAN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::CYAN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `bottom_to_top` method.
    scroll.bottom_to_top().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-left-right.rs (line 23)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" >>>123>>> ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `left_to_right` method.
    scroll.left_to_right().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-top-bottom.rs (line 23)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" vvv123vvv ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of YELLOW and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::YELLOW, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `top_to_bottom` method.
    scroll.top_to_bottom().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

examples/scroll-right-left.rs (line 23)

fn main() {
    // Connect to our LED Matrix screen.
    let mut screen = Screen::open("/dev/fb1").unwrap();

    // Get the default `FontCollection`.
    let fonts = FontCollection::new();
    // Create a sanitized `FontString`.
    let sanitized = fonts.sanitize_str(" «««123««« ").unwrap();
    // Render the `FontString` as a vector of pixel frames, with
    // a stroke color of GREEN and a BLACK background.
    let pixel_frames = sanitized.pixel_frames(PixelColor::GREEN, PixelColor::BLACK);

    // Create a `Scroll` from the pixel frame vector.
    let scroll = Scroll::new(&pixel_frames);

    // Consume the `FrameSequence` returned by the `right_to_left` method.
    scroll.right_to_left().for_each(|frame| {
        println!("Now printing:");
        println!("{:?}", frame);
        screen.write_frame(&frame.frame_line());
        ::std::thread::sleep(::std::time::Duration::from_millis(250));
    });
}

Trait Implementations

impl Clone for FontString

fn clone(&self) -> FontString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FontString

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

Formats the value using the given formatter.

impl Default for FontString

fn default() -> FontString

Returns the “default value” for a type.

impl Display for FontString

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

Formats the value using the given formatter.

impl PartialEq for FontString

fn eq(&self, other: &FontString) -> 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 StructuralPartialEq for FontString