Struct FontRef

pub struct FontRef<'a> {
    pub table_directory: TableRef<'a, TableDirectoryMarker>,
    /* private fields */
}

Reference to an in-memory font.

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

Fields

table_directory: TableRef<'a, TableDirectoryMarker>

Implementations

impl<'a> FontRef<'a>

pub fn new(data: &'a [u8]) -> Result<FontRef<'a>, 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<FontRef<'a>, 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 table_data(&self, tag: Tag) -> Option<FontData<'a>>

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> MetadataProvider<'a> for FontRef<'a>

fn attributes(&self) -> Attributes

Returns the primary attributes for font classification– stretch, style and weight.

fn axes(&self) -> AxisCollection<'a>

Returns the collection of variation axes.

fn named_instances(&self) -> NamedInstanceCollection<'a>

Returns the collection of named variation instances.

fn localized_strings(&self, id: StringId) -> LocalizedStrings<'a>

Returns an iterator over the collection of localized strings for the given informational string identifier.

fn metrics(&self, size: Size, location: impl Into<LocationRef<'a>>) -> Metrics

Returns the global font metrics for the specified size and location in normalized variation space.

fn glyph_metrics( &self, size: Size, location: impl Into<LocationRef<'a>>, ) -> GlyphMetrics<'a>

Returns the glyph specific metrics for the specified size and location in normalized variation space.

fn charmap(&self) -> Charmap<'a>

Returns the character to nominal glyph identifier mapping.

fn outline_glyphs(&self) -> OutlineGlyphCollection<'a>

Returns the collection of scalable glyph outlines.

If the font contains multiple outline sources, this method prioritizes glyf, CFF2 and CFF in that order. To select a specific outline source, use the OutlineGlyphCollection::with_format method.

fn color_glyphs(&self) -> ColorGlyphCollection<'a>

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>(&self) -> Result<T, ReadError>

where T: TopLevelTable + FontRead<'a>,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn gasp(&self) -> Result<TableRef<'a, GaspMarker>, 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<TableRef<'a, GlyfMarker>, ReadError>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn ift(&self) -> Result<Ift<'a>, ReadError>

fn iftx(&self) -> Result<Ift<'a>, ReadError>