Struct components::Units

pub struct Units(_);

Implementations

impl Units

pub fn get_unit_type(&self) -> UnitType

Retrieves the unit type of the value stored inside self

Returns

a unit type

pub fn get_unit_value(&self) -> f32

Retrieves the value stored inside self

Returns

the value stored inside a Units

pub fn to_pixels(&mut self) -> f32

Converts a value in Units to pixels

Returns

the value in pixels

pub fn from_cm(cm: f32) -> Units

Stores a value in centimeters inside units

units

a Units

cm

centimeters

pub fn from_em(em: f32) -> Units

Stores a value in em inside units, using the default font name as returned by Backend::get_font_name

units

a Units

em

em

pub fn from_em_for_font(font_name: Option<&str>, em: f32) -> Units

Stores a value in em inside units using font_name

units

a Units

font_name

the font name and size

em

em

pub fn from_mm(mm: f32) -> Units

Stores a value in millimiters inside units

units

a Units

mm

millimeters

pub fn from_pixels(px: i32) -> Units

Stores a value in pixels inside units

units

a Units

px

pixels

pub fn from_pt(pt: f32) -> Units

Stores a value in typographic points inside units

units

a Units

pt

typographic points

pub fn from_string(str: &str) -> Option<Units>

Parses a value and updates units with it

A Units expressed in string should match:

  units: wsp* unit-value wsp* unit-name? wsp*
  unit-value: number
  unit-name: 'px' | 'pt' | 'mm' | 'em' | 'cm'
  number: digit+
          | digit* sep digit+
  sep: '.' | ','
  digit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
  wsp: (#0x20 | #0x9 | #0xA | #0xB | #0xC | #0xD)+

For instance, these are valid strings:

  10 px
  5.1 em
  24 pt
  12.6 mm
  .3 cm

While these are not:

  42 cats
  omg!1!ponies

If no unit is specified, pixels are assumed.

units

a Units

str

the string to convert

Returns

true if the string was successfully parsed, and false otherwise

Trait Implementations

impl Clone for Units

pub fn clone(&self) -> Units

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Units

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

Formats the value using the given formatter.

impl Display for Units

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

Formats the value using the given formatter.

impl Eq for Units

impl Hash for Units

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Units

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Units> for Units

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

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

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

This method tests for !=.

impl PartialOrd<Units> for Units

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StaticType for Units

pub fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for Units

impl StructuralPartialEq for Units