Struct FontRef

pub struct FontRef<'a> {
    pub(crate) data: FontData<'a>,
    pub table_directory: TableDirectory<'a>,
    pub(crate) ttc_index: u32,
    pub(crate) in_ttc: bool,
    pub(crate) table_directory_sorted: bool,
}

Reference to an in-memory font.

This is a simple implementation of the TableProvider trait backed by a borrowed slice containing font data.

Fields

data: FontData<'a>

table_directory: TableDirectory<'a>

ttc_index: u32

The index of this font in a TrueType collection

in_ttc: bool

Whether this font is a member of a TrueType collection.

We use a bool rather than an Option to avoid bloating the struct size.

table_directory_sorted: bool

Implementations

impl<'a> FontRef<'a>

pub fn new(data: &'a [u8]) -> Result<Self, ReadError>

Creates a new reference to an in-memory font backed by the given data.

The data must be a single font (not a font collection) and must begin with a table directory to be considered valid.

To load a font from a font collection, use FontRef::from_index instead.

pub fn from_index(data: &'a [u8], index: u32) -> Result<Self, ReadError>

Creates a new reference to an in-memory font at the specified index backed by the given data.

The data slice must begin with either a table directory or a ttc header to be considered valid.

In other words, this accepts either font collection (ttc) or single font (ttf/otf) files. If a single font file is provided, the index parameter must be 0.

pub fn data(&self) -> FontData<'a>

Returns the underlying font data.

This is the base from which tables are loaded, meaning that for TrueType collection files, this will be the entire font file data.

pub fn ttc_index(&self) -> Option<u32>

If the font is in a TrueType collection (ttc) file, returns the index of the font in that collection.

pub fn table_directory(&self) -> &TableDirectory<'a>

Returns the associated table directory.

pub fn table_data(&self, tag: Tag) -> Option<FontData<'a>>

Returns the data for the table with the specified tag, if present.

pub fn fonts( data: &'a [u8], ) -> impl Iterator<Item = Result<FontRef<'a>, ReadError>> + 'a + Clone

Returns an iterator over all of the available fonts in the given font data.

pub(crate) fn with_table_directory( data: FontData<'a>, table_directory: TableDirectory<'a>, ttc_index: Option<u32>, ) -> Result<Self, ReadError>

Trait Implementations

impl<'a> Clone for FontRef<'a>

fn clone(&self) -> FontRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> TableProvider<'a> for FontRef<'a>

fn data_for_tag(&self, tag: Tag) -> Option<FontData<'a>>

fn expect_data_for_tag(&self, tag: Tag) -> Result<FontData<'a>, ReadError>

fn expect_table<T: TopLevelTable + FontRead<'a>>(&self) -> Result<T, ReadError>

fn head(&self) -> Result<Head<'a>, ReadError>

fn name(&self) -> Result<Name<'a>, ReadError>

fn hhea(&self) -> Result<Hhea<'a>, ReadError>

fn vhea(&self) -> Result<Vhea<'a>, ReadError>

fn hmtx(&self) -> Result<Hmtx<'a>, ReadError>

fn hdmx(&self) -> Result<Hdmx<'a>, ReadError>

fn vmtx(&self) -> Result<Vmtx<'a>, ReadError>

fn vorg(&self) -> Result<Vorg<'a>, ReadError>

fn fvar(&self) -> Result<Fvar<'a>, ReadError>

fn avar(&self) -> Result<Avar<'a>, ReadError>

fn hvar(&self) -> Result<Hvar<'a>, ReadError>

fn vvar(&self) -> Result<Vvar<'a>, ReadError>

fn mvar(&self) -> Result<Mvar<'a>, ReadError>

fn maxp(&self) -> Result<Maxp<'a>, ReadError>

fn os2(&self) -> Result<Os2<'a>, ReadError>

fn post(&self) -> Result<Post<'a>, ReadError>

fn gasp(&self) -> Result<Gasp<'a>, ReadError>

fn loca(&self, is_long: impl Into<Option<bool>>) -> Result<Loca<'a>, ReadError>

is_long can be optionally provided, if known, otherwise we look it up in head.

fn glyf(&self) -> Result<Glyf<'a>, ReadError>

fn gvar(&self) -> Result<Gvar<'a>, ReadError>

fn cvt(&self) -> Result<&'a [BigEndian<i16>], ReadError>

Returns the array of entries for the control value table which is used for TrueType hinting.

fn cvar(&self) -> Result<Cvar<'a>, ReadError>

fn cff(&self) -> Result<Cff<'a>, ReadError>

fn cff2(&self) -> Result<Cff2<'a>, ReadError>

fn cmap(&self) -> Result<Cmap<'a>, ReadError>

fn gdef(&self) -> Result<Gdef<'a>, ReadError>

fn gpos(&self) -> Result<Gpos<'a>, ReadError>

fn gsub(&self) -> Result<Gsub<'a>, ReadError>

fn feat(&self) -> Result<Feat<'a>, ReadError>

fn ltag(&self) -> Result<Ltag<'a>, ReadError>

fn ankr(&self) -> Result<Ankr<'a>, ReadError>

fn trak(&self) -> Result<Trak<'a>, ReadError>

fn morx(&self) -> Result<Morx<'a>, ReadError>

fn kerx(&self) -> Result<Kerx<'a>, ReadError>

fn kern(&self) -> Result<Kern<'a>, ReadError>

fn colr(&self) -> Result<Colr<'a>, ReadError>

fn cpal(&self) -> Result<Cpal<'a>, ReadError>

fn cblc(&self) -> Result<Cblc<'a>, ReadError>

fn cbdt(&self) -> Result<Cbdt<'a>, ReadError>

fn eblc(&self) -> Result<Eblc<'a>, ReadError>

fn ebdt(&self) -> Result<Ebdt<'a>, ReadError>

fn sbix(&self) -> Result<Sbix<'a>, ReadError>

fn stat(&self) -> Result<Stat<'a>, ReadError>

fn svg(&self) -> Result<Svg<'a>, ReadError>

fn varc(&self) -> Result<Varc<'a>, ReadError>

fn meta(&self) -> Result<Meta<'a>, ReadError>

fn base(&self) -> Result<Base<'a>, ReadError>

fn dsig(&self) -> Result<Dsig<'a>, ReadError>