Struct fontdb::Database

pub struct Database { /* fields omitted */ }

A font database.

Implementations

impl Database

pub fn new() -> Self

Create a new, empty Database.

Generic font families would be set to:

• serif - Times New Roman
• sans-serif - Arial
• cursive - Comic Sans MS
• fantasy - Impact (Papyrus on macOS)
• monospace - Courier New

pub fn load_font_data(&mut self, data: Vec<u8>)

Loads a font data into the Database.

Will load all font faces in case of a font collection.

pub fn load_font_file<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Error>

Loads a font file into the Database.

Will load all font faces in case of a font collection.

pub fn load_fonts_dir<P: AsRef<Path>>(&mut self, dir: P)

Loads font files from the selected directory into the Database.

This method will scan directories recursively.

Will load ttf, otf, ttc and otc fonts.

Unlike other load_* methods, this one doesn’t return an error. It will simply skip malformed fonts and will print a warning into the log for each of them.

pub fn load_system_fonts(&mut self)

Attempts to load system fonts.

Supports Windows, Linux and macOS.

System fonts loading is a surprisingly complicated task, mostly unsolvable without interacting with system libraries. And since fontdb tries to be small and portable, this method will simply scan some predefined directories. Which means that fonts that are not in those directories must be added manually.

pub fn remove_face(&mut self, id: ID) -> bool

Removes a font face by id from the database.

Returns false while attempting to remove a non-existing font face.

Useful when you want to ignore some specific font face(s) after loading a large directory with fonts. Or a specific face from a font.

pub fn is_empty(&self) -> bool

Returns true if the Database contains no font faces.

pub fn len(&self) -> usize

Returns the number of font faces in the Database.

Note that Database stores font faces, not fonts. For example, if a caller will try to load a font collection (*.ttc) that contains 5 faces, then the Database will load 5 font faces and this method will return 5, not 1.

pub fn set_serif_family<S: Into<String>>(&mut self, family: S)

Sets the family that will be used by Family::Serif.

pub fn set_sans_serif_family<S: Into<String>>(&mut self, family: S)

Sets the family that will be used by Family::SansSerif.

pub fn set_cursive_family<S: Into<String>>(&mut self, family: S)

Sets the family that will be used by Family::Cursive.

pub fn set_fantasy_family<S: Into<String>>(&mut self, family: S)

Sets the family that will be used by Family::Fantasy.

pub fn set_monospace_family<S: Into<String>>(&mut self, family: S)

Sets the family that will be used by Family::Monospace.

pub fn query(&self, query: &Query<'_>) -> Option<ID>

Performs a CSS-like query and returns the best matched font face.

pub fn faces(&self) -> &[FaceInfo]

Returns a reference to an internal storage.

This can be used for manual font matching.

pub fn face(&self, id: ID) -> Option<&FaceInfo>

Selects a FaceInfo by id.

Returns None if a face with such ID was already removed, or this ID belong to the other Database.

pub fn face_source(&self, id: ID) -> Option<(Arc<Source>, u32)>

Returns font face storage and the face index by ID.

pub fn with_face_data<P, T>(&self, id: ID, p: P) -> Option<T> where
    P: FnOnce(&[u8], u32) -> T, 

Executes a closure with a font’s data.

We can’t return a reference to a font binary data because of lifetimes. So instead, you can use this method to process font’s data.

The closure accepts raw font data and font face index.

In case of Source::File, the font file will be memory mapped.

Returns None when font file loading failed.

Example

let is_variable = db.with_face_data(id, |font_data, face_index| {
    let font = ttf_parser::Face::from_slice(font_data, face_index).unwrap();
    font.is_variable()
})?;

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Database

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

Formats the value using the given formatter.