Struct Length 

pub struct Length { /* private fields */ }

Length measurement stored as millipoints (1/1000 point)

Conversion factors:

• 1 point = 1/72 inch
• 1 inch = 72 points = 72000 millipoints
• 1 mm = 2.834645669 points
• 1 cm = 28.34645669 points

Font-relative units:

• 1em = current font-size
• 1ex = x-height of current font (typically ~0.5em)

Implementations

impl Length

pub const ZERO: Length

Zero length constant

pub fn from_pt(pt: f64) -> Length

Create a length from points

pub fn from_inch(inch: f64) -> Length

Create a length from inches

pub fn from_mm(mm: f64) -> Length

Create a length from millimeters

pub fn from_cm(cm: f64) -> Length

Create a length from centimeters

pub const fn from_millipoints(millipoints: i32) -> Length

Create a length from millipoints directly

pub fn from_em(em: f64) -> LengthUnit

Create a font-relative length in em units

1em equals the current font-size. The returned LengthUnit must be resolved with a FontContext to get an absolute length.

Examples

use fop_types::{Length, FontContext, LengthUnit};

let em_unit = LengthUnit::Em(1.5);
let context = FontContext::new(Length::from_pt(12.0));
let resolved = Length::resolve_unit(&em_unit, &context);
assert_eq!(resolved, Length::from_pt(18.0)); // 1.5 * 12pt

pub fn from_ex(ex: f64) -> LengthUnit

Create a font-relative length in ex units

1ex equals the x-height of the current font (typically ~0.5em). The returned LengthUnit must be resolved with a FontContext to get an absolute length.

Examples

use fop_types::{Length, FontContext, LengthUnit};

let ex_unit = LengthUnit::Ex(2.0);
let context = FontContext::new(Length::from_pt(12.0));
let resolved = Length::resolve_unit(&ex_unit, &context);
// 2.0 * 6pt (x-height is 0.5 * font-size)
assert_eq!(resolved, Length::from_pt(12.0));

pub fn resolve_unit(unit: &LengthUnit, context: &FontContext) -> Length

Resolve a LengthUnit to an absolute Length using a FontContext

For absolute units, returns the length directly. For em units, multiplies by the font size. For ex units, multiplies by the x-height.

Examples

use fop_types::{Length, FontContext, LengthUnit};

let context = FontContext::new(Length::from_pt(12.0));

// Absolute unit
let abs = LengthUnit::Absolute(12000);
assert_eq!(Length::resolve_unit(&abs, &context), Length::from_pt(12.0));

// Em unit
let em = LengthUnit::Em(1.5);
assert_eq!(Length::resolve_unit(&em, &context), Length::from_pt(18.0));

// Ex unit
let ex = LengthUnit::Ex(2.0);
assert_eq!(Length::resolve_unit(&ex, &context), Length::from_pt(12.0));

pub fn to_pt(self) -> f64

Get the value in points

pub fn to_inch(self) -> f64

Get the value in inches

pub fn to_mm(self) -> f64

Get the value in millimeters

pub fn to_cm(self) -> f64

Get the value in centimeters

pub const fn millipoints(self) -> i32

Get the raw millipoint value

pub fn abs(self) -> Length

Get the absolute value

Trait Implementations

impl Add for Length

type Output = Length

The resulting type after applying the + operator.

fn add(self, other: Length) -> Length

Performs the + operation.

impl AddAssign for Length

fn add_assign(&mut self, other: Length)

Performs the += operation.

impl Clone for Length

fn clone(&self) -> Length

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Length

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

Formats the value using the given formatter.

impl Display for Length

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

Formats the value using the given formatter.

impl Div<i32> for Length

type Output = Length

The resulting type after applying the / operator.

fn div(self, scalar: i32) -> Length

Performs the / operation.

impl Hash for Length

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 Mul<i32> for Length

type Output = Length

The resulting type after applying the * operator.

fn mul(self, scalar: i32) -> Length

Performs the * operation.

impl Neg for Length

type Output = Length

The resulting type after applying the - operator.

fn neg(self) -> Length

Performs the unary - operation.

impl Ord for Length

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

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

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

type Output = Length

The resulting type after applying the - operator.

fn sub(self, other: Length) -> Length

Performs the - operation.

impl SubAssign for Length

fn sub_assign(&mut self, other: Length)

Performs the -= operation.

impl Copy for Length

impl Eq for Length

impl StructuralPartialEq for Length