Struct Dim 

pub struct Dim { /* private fields */ }

TeX-style dimension: width, height, depth, italic correction, mu.

One unit is one em at the current math style unless a method says otherwise.

Examples

use latex_rust::Dim;

let half = Dim::ratio(1, 2);
assert!(half.eq_dim(&(&Dim::one() / &Dim::from_i64(2))));
assert!(!Dim::zero().eq_dim(&Dim::one()));

Implementations

impl Dim

pub fn zero() -> Self

Zero em.

pub fn one() -> Self

One em.

pub fn from_i64(v: i64) -> Self

Integer em count.

pub fn ratio(num: i64, den: i64) -> Self

Exact rational num / den em. den == 0 yields NaN.

pub fn parse(s: &str) -> Self

Parse a decimal string (optional sign, fraction, e exponent).

pub fn from_font_units(units: i64, units_per_em: u16) -> Self

Convert integer font units to em: units / units_per_em.

pub fn mu() -> Self

One math unit (mu). TeX: 18 mu = 1 em.

pub fn to_mu(&self) -> Self

Convert this em value to mu (* 18).

pub fn from_mu(mu: &Self) -> Self

Convert a mu value to em (/ 18).

pub fn abs(&self) -> Self

Absolute value.

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

Maximum of two dimensions.

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

Minimum of two dimensions.

pub fn clamp_nonneg(&self) -> Self

max(self, 0).

pub fn is_nan(&self) -> bool

True when the value is NaN.

pub fn is_zero(&self) -> bool

True when the value compares equal to zero.

pub fn as_ratio(&self) -> Option<(i128, i128)>

The exact rational value in em, as (numerator, denominator), or None if this dimension is NaN.

The denominator is positive and the fraction is in lowest terms. This is the only accessor that does not round: Self::to_dec_string formats a decimal expansion and Self::to_ieee32_bits rounds to binary32. An external renderer that wants to convert at its own pixel boundary, rather than take the crate’s rounding, should start here.

Examples

use latex_rust::Dim;

assert_eq!(Dim::ratio(2, 6).as_ratio(), Some((1, 3)));
assert_eq!(Dim::ratio(1, -2).as_ratio(), Some((-1, 2)));
assert_eq!(Dim::zero().as_ratio(), Some((0, 1)));
assert_eq!(Dim::ratio(1, 0).as_ratio(), None);

pub fn to_dec_string(&self) -> String

Decimal string (exact terminating expansion, or scientific).

pub fn to_svg_string(&self) -> String

Compact decimal for SVG attributes.

pub fn from_ieee32_bits(bits: u32) -> Self

Layout dimension from an IEEE-754 binary32 bit pattern (outline boundary).

pub fn to_ieee32_bits(&self) -> u32

Round to IEEE-754 binary32 bits for PNG / raster emission only.

pub fn floor_to_u32(&self) -> Result<u32, Error>

Largest u32 that is not greater than self. Negative and NaN fail.

pub fn ceil_to_u32(&self) -> Result<u32, Error>

Smallest u32 that is not less than self.

pub fn cmp(&self, other: &Self) -> Option<Ordering>

Compare two dimensions. None if either is NaN.

pub fn eq_dim(&self, other: &Self) -> bool

True when self and other compare equal.

Trait Implementations

impl Add for Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: Dim) -> Dim

Performs the + operation.

impl Add for &Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: &Dim) -> Dim

Performs the + operation.

impl Add<&Dim> for Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: &Dim) -> Dim

Performs the + operation.

impl Add<Dim> for &Dim

type Output = Dim

The resulting type after applying the + operator.

fn add(self, rhs: Dim) -> Dim

Performs the + operation.

impl Clone for Dim

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dim

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

Formats the value using the given formatter.

impl Display for Dim

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

Formats the value using the given formatter.

impl Div for Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: Dim) -> Dim

Performs the / operation.

impl Div for &Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: &Dim) -> Dim

Performs the / operation.

impl Div<&Dim> for Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: &Dim) -> Dim

Performs the / operation.

impl Div<Dim> for &Dim

type Output = Dim

The resulting type after applying the / operator.

fn div(self, rhs: Dim) -> Dim

Performs the / operation.

impl Eq for Dim

impl Mul for Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: Dim) -> Dim

Performs the * operation.

impl Mul for &Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: &Dim) -> Dim

Performs the * operation.

impl Mul<&Dim> for Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: &Dim) -> Dim

Performs the * operation.

impl Mul<Dim> for &Dim

type Output = Dim

The resulting type after applying the * operator.

fn mul(self, rhs: Dim) -> Dim

Performs the * operation.

impl Neg for Dim

type Output = Dim

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Dim

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Dim

fn partial_cmp(&self, other: &Self) -> 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 Sub for Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: Dim) -> Dim

Performs the - operation.

impl Sub for &Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: &Dim) -> Dim

Performs the - operation.

impl Sub<&Dim> for Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: &Dim) -> Dim

Performs the - operation.

impl Sub<Dim> for &Dim

type Output = Dim

The resulting type after applying the - operator.

fn sub(self, rhs: Dim) -> Dim

Performs the - operation.