Struct FontWidth 

pub struct FontWidth(/* private fields */);

Visual width of a font– a relative change from the normal aspect ratio, typically in the range 0.5 to 2.0.

The default value is FontWidth::NORMAL or 1.0.

In variable fonts, this can be controlled with the wdth axis. This is an f32 so that it can represent the same range of values as the wdth axis.

In Open Type, the u16 usWidthClass field has 9 values, from 1-9, which doesn’t allow for the wide range of values possible with variable fonts.

See https://fonts.google.com/knowledge/glossary/width

In CSS, this corresponds to the font-width property.

This has also been known as “stretch” and has a legacy CSS name alias, font-stretch.

Implementations

impl FontWidth

pub const ULTRA_CONDENSED: FontWidth

Width that is 50% of normal.

pub const EXTRA_CONDENSED: FontWidth

Width that is 62.5% of normal.

pub const CONDENSED: FontWidth

Width that is 75% of normal.

pub const SEMI_CONDENSED: FontWidth

Width that is 87.5% of normal.

pub const NORMAL: FontWidth

Width that is 100% of normal. This is the default value.

pub const SEMI_EXPANDED: FontWidth

Width that is 112.5% of normal.

pub const EXPANDED: FontWidth

Width that is 125% of normal.

pub const EXTRA_EXPANDED: FontWidth

Width that is 150% of normal.

pub const ULTRA_EXPANDED: FontWidth

Width that is 200% of normal.

impl FontWidth

pub fn from_ratio(ratio: f32) -> FontWidth

Creates a new width attribute with the given ratio.

This can also be created from a percentage.

Example

assert_eq!(FontWidth::from_ratio(1.5), FontWidth::EXTRA_EXPANDED);

pub fn from_percentage(percentage: f32) -> FontWidth

Creates a width attribute from a percentage.

This can also be created from a ratio.

Example

assert_eq!(FontWidth::from_percentage(87.5), FontWidth::SEMI_CONDENSED);

pub fn ratio(self) -> f32

Returns the width attribute as a ratio.

This is a linear scaling factor with 1.0 being “normal” width.

Example

assert_eq!(FontWidth::NORMAL.ratio(), 1.0);

pub fn percentage(self) -> f32

Returns the width attribute as a percentage value.

This is generally the value associated with the wdth axis.

pub fn is_normal(self) -> bool

Returns true if the width is normal.

pub fn is_condensed(self) -> bool

Returns true if the width is condensed (less than normal).

pub fn is_expanded(self) -> bool

Returns true if the width is expanded (greater than normal).

pub fn parse(s: &str) -> Option<FontWidth>

Parses the width from a CSS style keyword or a percentage value.

Examples

assert_eq!(FontWidth::parse("semi-condensed"), Some(FontWidth::SEMI_CONDENSED));
assert_eq!(FontWidth::parse("80%"), Some(FontWidth::from_percentage(80.0)));
assert_eq!(FontWidth::parse("wideload"), None);

impl FontWidth

pub fn from_fontconfig(width: i32) -> FontWidth

Creates a new width attribute with the given value from Fontconfig.

The values are determined based on the fonts.conf documentation.

Trait Implementations

impl Clone for FontWidth

fn clone(&self) -> FontWidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FontWidth

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

Formats the value using the given formatter.

impl Default for FontWidth

fn default() -> FontWidth

Returns the “default value” for a type.

impl Display for FontWidth

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

Formats the value using the given formatter.

impl PartialEq for FontWidth

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

fn partial_cmp(&self, other: &FontWidth) -> 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 Copy for FontWidth

impl StructuralPartialEq for FontWidth