Struct Length

pub struct Length {
    pub abs: Abs,
    pub em: Em,
}

A size or distance, possibly expressed with contextual units.

Typst supports the following length units:

• Points: {72pt}
• Millimeters: {254mm}
• Centimeters: {2.54cm}
• Inches: {1in}
• Relative to font size: {2.5em}

You can multiply lengths with and divide them by integers and floats.

Example

#rect(width: 20pt)
#rect(width: 2em)
#rect(width: 1in)

#(3em + 5pt).em \
#(20pt).em \
#(40em + 2pt).abs \
#(5em).abs

Fields

• abs: A length with just the absolute component of the current length (that is, excluding the em component).
• em: The amount of em units in this length, as a [float].

Fields

abs: Abs

The absolute part.

em: Em

The font-relative part.

Implementations

impl Length

pub const fn zero() -> Self

The zero length.

pub fn try_abs(self) -> Option<Self>

Try to compute the absolute value of the length.

pub fn try_div(self, other: Self) -> Option<f64>

Try to divide two lengths.

pub fn at(self, font_size: Abs) -> Abs

Convert to an absolute length at the given font size.

impl Length

pub fn to_pt(&self, span: Span) -> SourceResult<f64>

Converts this length to points.

Fails with an error if this length has non-zero em units (such as 5em + 2pt instead of just 2pt). Use the abs field (such as in (5em + 2pt).abs.pt()) to ignore the em component of the length (thus converting only its absolute component).

pub fn to_mm(&self, span: Span) -> SourceResult<f64>

Converts this length to millimeters.

Fails with an error if this length has non-zero em units. See the pt method for more details.

pub fn to_cm(&self, span: Span) -> SourceResult<f64>

Converts this length to centimeters.

Fails with an error if this length has non-zero em units. See the pt method for more details.

pub fn to_inches(&self, span: Span) -> SourceResult<f64>

Converts this length to inches.

Fails with an error if this length has non-zero em units. See the pt method for more details.

pub fn to_absolute( &self, context: Tracked<'_, Context<'_>>, ) -> HintedStrResult<Length>

Resolve this length to an absolute length.

#set text(size: 12pt)
#context [
  #(6pt).to-absolute() \
  #(6pt + 10em).to-absolute() \
  #(10em).to-absolute()
]

#set text(size: 6pt)
#context [
  #(6pt).to-absolute() \
  #(6pt + 10em).to-absolute() \
  #(10em).to-absolute()
]

Trait Implementations

impl Add for Length

type Output = Length

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

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

Formats the value using the given formatter.

impl Default for Length

fn default() -> Length

Returns the “default value” for a type.

impl Div<f64> for Length

type Output = Length

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for Length

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl Fold for Length

fn fold(self, _: Self) -> Self

Fold this inner value with an outer folded value.

impl From<Abs> for Length

fn from(abs: Abs) -> Self

Converts to this type from the input type.

impl From<Em> for Length

fn from(em: Em) -> Self

Converts to this type from the input type.

impl From<Length> for Spacing

fn from(length: Length) -> Self

Converts to this type from the input type.

impl FromValue for Length

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Length

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 IntoValue for Length

fn into_value(self) -> Value

Cast this type into a value.

impl Mul<Length> for f64

type Output = Length

The resulting type after applying the * operator.

fn mul(self, rhs: Length) -> Self::Output

Performs the * operation.

impl Mul<f64> for Length

type Output = Length

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Length

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl NativeScope for Length

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Length

const NAME: &'static str = "length"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Neg for Length

type Output = Length

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Numeric for Length

fn zero() -> Self

The identity element for addition.

fn is_finite(self) -> bool

Whether self consists only of finite parts.

fn is_zero(self) -> bool

Whether self is zero.

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: &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 Reflect for Length

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Length

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Resolve for Length

type Output = Abs

The type of the resolved output.

fn resolve(self, styles: StyleChain<'_>) -> Self::Output

Resolve the value using the style chain.

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