[][src]Struct rusttype::FontCollection

pub struct FontCollection<'a>(_);

A collection of fonts read straight from a font file's data. The data in the collection is not validated. This structure may or may not own the font data.

Lifetime

The lifetime reflects the font data lifetime. FontCollection<'static> covers most cases ie both dynamically loaded owned data and for referenced compile time font data.

Methods

impl<'a> FontCollection<'a>[src]

pub fn from_bytes<B: Into<SharedBytes<'a>>>(
    bytes: B
) -> Result<FontCollection<'a>, Error>
[src]

Constructs a font collection from an array of bytes, typically loaded from a font file, which may be a single font or a TrueType Collection holding a number of fonts. This array may be owned (e.g. Vec<u8>), or borrowed (&[u8]). As long as From<T> is implemented for Bytes for some type T, T can be used as input.

This returns an error if bytes does not seem to be font data in a format we recognize.

pub fn into_font(self) -> Result<Font<'a>, Error>[src]

If this FontCollection holds a single font, or a TrueType Collection containing only one font, return that as a Font. The FontCollection is consumed.

If this FontCollection holds multiple fonts, return a CollectionContainsMultipleFonts error.

If an error occurs, the FontCollection is lost, since this function takes ownership of it, and the error values don't give it back. If that is a problem, use the font_at or into_fonts methods instead, which borrow the FontCollection rather than taking ownership of it.

pub fn font_at(&self, i: usize) -> Result<Font<'a>, Error>[src]

Gets the font at index i in the font collection, if it exists and is valid. The produced font borrows the font data that is either borrowed or owned by this font collection.

Important traits for IntoFontsIter<'a>
pub fn into_fonts(self) -> IntoFontsIter<'a>[src]

Converts self into an Iterator yielding each Font that exists within the collection.

Trait Implementations

impl<'a> Clone for FontCollection<'a>[src]

impl<'a> Debug for FontCollection<'a>[src]

Auto Trait Implementations

impl<'a> Send for FontCollection<'a>

impl<'a> Unpin for FontCollection<'a>

impl<'a> Sync for FontCollection<'a>

impl<'a> UnwindSafe for FontCollection<'a>

impl<'a> RefUnwindSafe for FontCollection<'a>

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]