Struct manifest::v2::FontFamilyAliasSet

pub struct FontFamilyAliasSet { /* private fields */ }

Represents a set of font family aliases, and optionally, typeface properties that should be applied when treating those aliases as the canonical family.

For example, the font family "Roboto" might have one alias set of the form:

{
  "names": [ "Roboto Condensed" ],
  "width": "condensed"
}

This means that when a client requests the family "Roboto Condensed", the font server will treat that as a request for "Roboto" with Width::Condensed.

The font family "Noto Sans CJK" might have aliases of the form:

[
  {
    "names": [ "Noto Sans CJK KR", "Noto Sans KR" ],
    "languages": [ "ko" ]
  },
  {
    "names": [ "Noto Sans CJK JP", "Noto Sans JP" ],
    "languages: [ "ja" ]
  }
]

When a client requests "Noto Sans CJK JP" or "Noto Sans JP", the font server will look under "Noto Sans CJK" for typefaces that support Japanese ("ja").

Create using FontFamilyAliasSet::new if the aliases will map to typeface property overrides, or FontFamilyAliasSet::without_overrides to create a plain set of aliases.

When loaded by the font server, a FontFamilyAliasSet is expanded over all the names, creating an alias entry for every name, with identical style and languages values.

Implementations

impl FontFamilyAliasSet

pub fn new( names: impl IntoIterator<Item = impl AsRef<str>>, style: impl Into<StyleOptions>, languages: impl IntoIterator<Item = impl AsRef<str>> ) -> Result<Self, Error>

Create a new FontFamilyAliasSet with one or more names, and with optional style and language overrides.

• names: A list of one more alias names
• style: Optionally, style overrides that are automatically applied to the typeface request when one of the names is requested.
• languages: Optionally, a list of language codes that is automatically applied to the typeface request when one of the names is requested. Do not sort the language codes. They are given in priority order, just as in TypefaceQuery.languages.

Examples:

use manifest::v2::FontFamilyAliasSet;
use manifest::serde_ext::StyleOptions;

// Alias set for "Noto Sans CJK" for Traditional Chinese. Both `"Noto Sans CJK TC"` and
// `"Noto Sans TC"` will serve as aliases that apply the languages `["zh-Hant", "zh-Bopo"]`
// when requested.
FontFamilyAliasSet::new(
    vec!["Noto Sans CJK TC", "Noto Sans TC"],
    StyleOptions::default(),
    vec!["zh-Hant", "zh-Bopo"]);

// Alias set for "Roboto Condensed". `"Roboto Condensed"` will serve as an alias that
// applies the style options `width: condensed` when requested.
FontFamilyAliasSet::new(
    vec!["Roboto Condensed"],
    StyleOptions {
        width: Some(fidl_fuchsia_fonts::Width::Condensed),
        ..Default::default()
    },
    vec![]);

pub fn without_overrides( names: impl IntoIterator<Item = impl AsRef<str>> ) -> Result<Self, Error>

Create a new FontFamilyAliasSet with one or more names, with no typeface property overrides.

pub fn names(&self) -> impl Iterator<Item = &String>

Gets the alias names in this set.

pub fn style_overrides(&self) -> &StyleOptions

Gets the style property overrides for this set of aliases (may be empty).

pub fn language_overrides(&self) -> impl Iterator<Item = &String>

Gets the language code overrides for this set of aliases (may be empty).

pub fn has_overrides(&self) -> bool

Whether the alias set has any property overrides. If false, it’s just a name alias.

pub fn has_style_overrides(&self) -> bool

Whether the alias set has style overrides.

pub fn has_language_overrides(&self) -> bool

Whether the alias set has language overrides.

Trait Implementations

impl Clone for FontFamilyAliasSet

fn clone(&self) -> FontFamilyAliasSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FontFamilyAliasSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FontFamilyAliasSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FontFamilyAliasSet

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 PartialEq for FontFamilyAliasSet

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FontFamilyAliasSet

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 FontFamilyAliasSet

impl StructuralPartialEq for FontFamilyAliasSet