Struct Install 

pub struct Install { /* private fields */ }

How to install the font: the archive, the folder and whether the system is told.

Install::new is what install runs. The other methods are for installing elsewhere, such as into a test’s temporary folder.

Implementations

impl Install

pub fn new() -> Self

The release archive into target_dir, telling the system about the new font.

pub fn archive(self, archive: Archive) -> Self

Installs from archive instead of the release.

pub fn target(self, dir: impl Into<PathBuf>) -> Self

Installs into dir instead of target_dir. The folder is created when missing.

pub fn register(self, register: bool) -> Self

Whether the system is told about the new font, on by default: on Linux fc-cache -f reads the folder (skipped when fontconfig is not installed), on Windows the font is entered under HKCU\Software\Microsoft\Windows NT\CurrentVersion\Fonts, and macOS needs nothing. Turn it off for a folder the system does not look at.

pub fn target_dir(&self) -> Option<&Path>

The folder the font goes into, if there is one.

pub fn run( self, cancel: &dyn Fn() -> bool, on_progress: &mut dyn FnMut(Progress), ) -> Result<PathBuf, InstallError>

Downloads, verifies and installs, on the calling thread, handing every step to on_progress; the last one is Progress::Done or Progress::Failed. Returns the path Progress::Done names.

cancel is asked between steps and while a program runs; when it turns true the program is stopped and nothing more is written. The download is kept in a folder of its own under the system’s temporary folder and removed at the end, whatever the outcome.

Errors

Every way the install can fail is an InstallError, also handed to on_progress as Progress::Failed unless the install was cancelled.

pub fn task<Msg: Send + 'static>( self, on_progress: impl Fn(Progress) -> Msg + Send + Sync + 'static, ) -> Task<Msg>

The install as a background Task. Every step arrives as on_progress(step), and the task’s own result is on_progress(Progress::Done { .. }). A failure arrives as Progress::Failed and also fails the task with the same text, so a TaskList shows it; the task’s label and notes are translated when this is called, so call it where the application’s language is active, such as in update.

Trait Implementations

impl Clone for Install

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Install

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

Formats the value using the given formatter.

impl Default for Install

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Install

impl PartialEq for Install

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Install