Struct FontSource 

#[non_exhaustive]
pub struct FontSource {
    pub repo_url: String,
    pub config: PathBuf,
    /* private fields */
}

Information about a font source in a git repository

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

repo_url: String

The repository’s url

config: PathBuf

The path to the config file for this font, relative to the repo root.

(if it is an external config, it is relative to the git cache root.)

Implementations

impl FontSource

pub fn repo_org(&self) -> &str

The name of the user or org that the repository lives under.

This is ‘googlefonts’ for the repo https://github.com/googlefonts/google-fonts-sources

pub fn repo_name(&self) -> &str

The name of the repository.

This is everything after the trailing ‘/’ in e.g. https://github.com/PaoloBiagini/Joan

pub fn git_rev(&self) -> &str

The commit rev of the repository’s main branch, at discovery time.

pub fn repo_path(&self, cache_dir: &Path) -> PathBuf

Given a root cache directory, return the local path this repo.

This is in the format, {cache_dir}/{repo_org}/{repo_name}

pub fn instantiate(&self, cache_dir: &Path) -> Result<PathBuf, LoadRepoError>

Attempt to checkout/update this repo to the provided cache_dir.

The repo will be checked out to ‘{cache_dir}/{repo_org}/{repo_name}’, and HEAD will be set to the self.git_rev().

Returns the path to the checkout on success.

Returns an error if the repo cannot be cloned, the git rev cannot be found, or if there is an io error.

pub fn config_is_external(&self) -> bool

An ‘external’ config is one that does not exist in the source repository.

Instead it lives in the google/fonts repository, alongside the metadata file for this family.

The caller must figure out how to handle this. The actual config path can be retrieved using the config_path method here.

pub fn config_path(&self, cache_dir: &Path) -> Result<PathBuf, LoadRepoError>

Return path to the config file for this repo, if it exists.

Returns an error if the repo cannot be cloned, or if no config files are found.

pub fn get_sources( &self, git_cache_dir: &Path, ) -> Result<Vec<PathBuf>, LoadRepoError>

Return a Vec of source files in this respository.

If necessary, this will create a new checkout of this repo at ‘{git_cache_dir}/{repo_org}/{repo_name}’.

Trait Implementations

impl Clone for FontSource

fn clone(&self) -> FontSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FontSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FontSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FontSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FontSource

fn cmp(&self, other: &FontSource) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FontSource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FontSource

fn partial_cmp(&self, other: &FontSource) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FontSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FontSource

impl StructuralPartialEq for FontSource