Struct Rel 

pub struct Rel<T: Numeric = Length> {
    pub rel: Ratio,
    pub abs: T,
}

A length in relation to some known length.

This type is a combination of a [length] with a [ratio]. It results from addition and subtraction of a length and a ratio. Wherever a relative length is expected, you can also use a bare length or ratio.

Relative to the page

A common use case is setting the width or height of a layout element (e.g., [block], [rect], etc.) as a certain percentage of the width of the page. Here, the rectangle’s width is set to {25%}, so it takes up one fourth of the page’s inner width (the width minus margins).

#rect(width: 25%)

Bare lengths or ratios are always valid where relative lengths are expected, but the two can also be freely mixed:

#rect(width: 25% + 1cm)

If you’re trying to size an element so that it takes up the page’s full width, you have a few options (this highly depends on your exact use case):

1. Set page margins to {0pt} ([#set page(margin: 0pt)])
2. Multiply the ratio by the known full page width ({21cm * 69%})
3. Use padding which will negate the margins ([#pad(x: -2.5cm, ...)])
4. Use the page background or foreground field as those don’t take margins into account (note that it will render the content outside of the document flow, see [place] to control the content position)

Relative to a container

When a layout element (e.g. a [rect]) is nested in another layout container (e.g. a [block]) instead of being a direct descendant of the page, relative widths become relative to the container:

#block(
  width: 100pt,
  fill: aqua,
  rect(width: 50%),
)

Scripting

You can multiply relative lengths by ratios, integers, and floats.

A relative length has the following fields:

• length: Its length component.
• ratio: Its ratio component.

#(100% - 50pt).length \
#(100% - 50pt).ratio

Fields

rel: Ratio

The relative part.

abs: T

The absolute part.

Implementations

impl<T: Numeric> Rel<T>

pub fn zero() -> Self

The zero relative.

pub fn one() -> Self

A relative with a ratio of 100% and no absolute part.

pub const fn new(rel: Ratio, abs: T) -> Self

Create a new relative from its parts.

pub fn is_zero(self) -> bool

Whether both parts are zero.

pub fn is_one(self) -> bool

Whether the relative part is one and the absolute part is zero.

pub fn relative_to(self, whole: T) -> T

Evaluate this relative to the given whole.

pub fn map<F, U>(self, f: F) -> Rel<U>

where F: FnOnce(T) -> U, U: Numeric,

Map the absolute part with f.

impl Rel<Length>

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

Try to divide two relative lengths.

Trait Implementations

impl<T: Numeric> Add<Ratio> for Rel<T>

type Output = Rel<T>

The resulting type after applying the + operator.

fn add(self, other: Ratio) -> Self::Output

Performs the + operation.

impl<T: Numeric> Add<T> for Rel<T>

type Output = Rel<T>

The resulting type after applying the + operator.

fn add(self, other: T) -> Self::Output

Performs the + operation.

impl<T: Numeric> Add for Rel<T>

type Output = Rel<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Numeric + AddAssign> AddAssign for Rel<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Clone + Numeric> Clone for Rel<T>

fn clone(&self) -> Rel<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Numeric + Debug> Debug for Rel<T>

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

Formats the value using the given formatter.

impl<T: Default + Numeric> Default for Rel<T>

fn default() -> Rel<T>

Returns the “default value” for a type.

impl<T: Numeric> Div<f64> for Rel<T>

type Output = Rel<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Numeric + DivAssign<f64>> DivAssign<f64> for Rel<T>

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl<T> Fold for Rel<T>

where T: Numeric + Fold,

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

Fold this inner value with an outer folded value.

impl From<Abs> for Rel<Length>

fn from(abs: Abs) -> Self

Converts to this type from the input type.

impl From<Em> for Rel<Length>

fn from(em: Em) -> Self

Converts to this type from the input type.

impl<T: Numeric> From<Ratio> for Rel<T>

fn from(rel: Ratio) -> Self

Converts to this type from the input type.

impl<T: Numeric> From<T> for Rel<T>

fn from(abs: T) -> Self

Converts to this type from the input type.

impl FromValue for Rel<Length>

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

Try to cast the value into an instance of Self.

impl<T: Hash + Numeric> Hash for Rel<T>

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 Rel<Length>

fn into_value(self) -> Value

Cast this type into a value.

impl IntoValue for Rel<Abs>

fn into_value(self) -> Value

Cast this type into a value.

impl<T: Numeric> Mul<Rel<T>> for f64

type Output = Rel<T>

The resulting type after applying the * operator.

fn mul(self, other: Rel<T>) -> Self::Output

Performs the * operation.

impl<T: Numeric> Mul<f64> for Rel<T>

type Output = Rel<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Numeric + MulAssign<f64>> MulAssign<f64> for Rel<T>

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl NativeType for Rel

const NAME: &'static str = "relative"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl<T: Numeric> Neg for Rel<T>

type Output = Rel<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq + Numeric> PartialEq for Rel<T>

fn eq(&self, other: &Rel<T>) -> 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<T: Numeric + PartialOrd> PartialOrd for Rel<T>

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 Rel<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<T: Numeric + Repr> Repr for Rel<T>

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl<T> Resolve for Rel<T>

where T: Resolve + Numeric, <T as Resolve>::Output: Numeric,

type Output = Rel<<T as Resolve>::Output>

The type of the resolved output.

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

Resolve the value using the style chain.

impl<T: Numeric> Sub for Rel<T>

type Output = Rel<T>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T: Numeric + SubAssign> SubAssign for Rel<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Copy + Numeric> Copy for Rel<T>

impl<T: Eq + Numeric> Eq for Rel<T>

impl<T: Numeric> StructuralPartialEq for Rel<T>