Struct piet_common::FontFamily

pub struct FontFamily(_);

A reference to a font family.

This may be either a CSS-style “generic family name”, such as “serif” or “monospace”, or it can be an explicit family name.

To use a generic family name, use the provided associated constants: FontFamily::SERIF, FontFamily::SANS_SERIF, FontFamily::SYSTEM_UI, and FontFamily::MONOSPACE.

To use a specific font family you should not construct this type directly; instead you should verify that the desired family exists, via the Text::font API.

Implementations

impl FontFamily

pub const SANS_SERIF: FontFamily = FontFamily(FontFamilyInner::SansSerif)

A san-serif font, such as Arial or Helvetica.

pub const SERIF: FontFamily = FontFamily(FontFamilyInner::Serif)

A serif font, such as Times New Roman or Charter.

pub const SYSTEM_UI: FontFamily = FontFamily(FontFamilyInner::SystemUi)

The platform’s preferred UI font; San Francisco on macOS, and Segoe UI on recent Windows.

pub const MONOSPACE: FontFamily = FontFamily(FontFamilyInner::Monospace)

A monospace font.

pub fn new_unchecked(s: impl Into<Arc<str>>) -> FontFamily

Create a new font family with a given name, without verifying that it exists.

This should generally not be used; instead you should create a FontFamily by calling the Text::font_family method, which verifies that the family name exists.

pub fn name(&self) -> &str

The name of the font family.

pub fn is_generic(&self) -> bool

Returns true if this is a generic font family.

Trait Implementations

impl Clone for FontFamily

fn clone(&self) -> FontFamily

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FontFamily

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

Formats the value using the given formatter.

impl Default for FontFamily

fn default() -> FontFamily

Returns the “default value” for a type.

impl From<FontFamily> for TextAttribute

fn from(t: FontFamily) -> TextAttribute

Converts to this type from the input type.

impl Hash for FontFamily

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

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<FontFamily> for FontFamily

fn eq(&self, other: &FontFamily) -> 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 Eq for FontFamily

impl StructuralEq for FontFamily

impl StructuralPartialEq for FontFamily