Struct Font

pub struct Font { /* private fields */ }

A parsed font, with access to its glyphs and stored strings

Implementations

impl Font

pub fn new(font_data: &[u8]) -> Result<Font, ParseError>

Creates a new font from the given font data

Errors

Returns an error if the font data is invalid or cannot be parsed

pub fn from_file(path: impl AsRef<Path>) -> Result<Font, ParseError>

Creates a new font from the font file at the specified path

Errors

Returns an error if the font data is invalid or cannot be parsed

Examples found in repository

examples/loading_fonts.rs (line 8)

fn main() -> ParseResult<()> {
    let font = Font::from_file("examples/slick.ttf")?;
    let font_name = font.string(StringKind::FullFontName).unwrap();
    println!(
        "Font `{font_name}` contains {} glyphs: ",
        font.glyphs().len()
    );

    font.glyphs().iter().for_each(|glyph| {
        let name = glyph.name();
        let codepoint = glyph.codepoint();
        println!("- `{name}` has codepoint {codepoint:04x}");

        //
        // You can also export the glyph as an image
        let _outline = glyph.svg_outline();
    });

    Ok(())
}

pub fn string(&self, kind: NameKind) -> Option<&str>

Returns the string with the specified kind, if it exists

Examples found in repository

examples/loading_fonts.rs (line 9)

fn main() -> ParseResult<()> {
    let font = Font::from_file("examples/slick.ttf")?;
    let font_name = font.string(StringKind::FullFontName).unwrap();
    println!(
        "Font `{font_name}` contains {} glyphs: ",
        font.glyphs().len()
    );

    font.glyphs().iter().for_each(|glyph| {
        let name = glyph.name();
        let codepoint = glyph.codepoint();
        println!("- `{name}` has codepoint {codepoint:04x}");

        //
        // You can also export the glyph as an image
        let _outline = glyph.svg_outline();
    });

    Ok(())
}

pub fn strings(&self) -> &HashMap<NameKind, String>

Returns all the strings in the font

pub fn glyph(&self, codepoint: u32) -> Option<&Glyph>

Returns the glyph with the specified unicode codepoint, if it exists

pub fn glyph_named(&self, name: &str) -> Option<&Glyph>

Returns the glyph with the specified postscript name, if it exists

pub fn glyphs(&self) -> &[Glyph]

Returns the glyphs in the font

Examples found in repository

examples/loading_fonts.rs (line 12)

fn main() -> ParseResult<()> {
    let font = Font::from_file("examples/slick.ttf")?;
    let font_name = font.string(StringKind::FullFontName).unwrap();
    println!(
        "Font `{font_name}` contains {} glyphs: ",
        font.glyphs().len()
    );

    font.glyphs().iter().for_each(|glyph| {
        let name = glyph.name();
        let codepoint = glyph.codepoint();
        println!("- `{name}` has codepoint {codepoint:04x}");

        //
        // You can also export the glyph as an image
        let _outline = glyph.svg_outline();
    });

    Ok(())
}

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

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

Formats the value using the given formatter.

impl FontCodegenExt for Font

fn gen_enum(&self, name: &str) -> TokenStream

Generates an enum representing the glyphs in the font

fn gen_enum_comments(&self) -> Vec<String>

Generates the comments for the enum

fn gen_enum_entry(glyph: &Glyph) -> TokenStream

Generates a single entry in the enum for a glyph

impl From<TrueTypeFont> for Font

fn from(value: TrueTypeFont) -> Font

Converts to this type from the input type.