Struct FontWidth 

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

Visual width of a font– a relative change from the normal aspect ratio, typically in the 50% - 200% range.

The default value is FontWidth::NORMAL.

In variable fonts, this can be controlled with 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, formerly known as font-stretch.

Implementations

impl FontWidth

pub const ULTRA_CONDENSED: Self

Width that is 50% of normal.

pub const EXTRA_CONDENSED: Self

Width that is 62.5% of normal.

pub const CONDENSED: Self

Width that is 75% of normal.

pub const SEMI_CONDENSED: Self

Width that is 87.5% of normal.

pub const NORMAL: Self

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

pub const SEMI_EXPANDED: Self

Width that is 112.5% of normal.

pub const EXPANDED: Self

Width that is 125% of normal.

pub const EXTRA_EXPANDED: Self

Width that is 150% of normal.

pub const ULTRA_EXPANDED: Self

Width that is 200% of normal.

impl FontWidth

pub fn from_ratio(ratio: f32) -> Self

Creates a new width attribute with the given ratio.

Panics if the ratio is not between 0 and 255.996.

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) -> Self

Creates a width attribute from a percentage.

Panics if the percentage is not between 0% and 25599.6%.

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<Self>

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);

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 Copy for FontWidth

impl Debug for FontWidth

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

Formats the value using the given formatter.

impl Default for FontWidth

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FontWidth

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<FontWidth, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for FontWidth

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

Formats the value using the given formatter.

impl Eq for FontWidth

impl From<FontWidth> for FontWidth

fn from(width: FontWidth) -> Self

Converts to this type from the input type.

impl Hash for FontWidth

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 FontWidth

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

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FontWidth