Struct Ratio 

pub struct Ratio(/* private fields */);

A ratio of a whole.

A ratio is written as a number, followed by a percent sign. Ratios most often appear as part of a relative length, to specify the size of some layout element relative to the page or some container.

#rect(width: 25%)

However, they can also describe any other property that is relative to some base, e.g. an amount of horizontal scaling or the height of parentheses relative to the height of the content they enclose.

Scripting

Within your own code, you can use ratios as you like. You can multiply them with various other types as shown below:

Multiply by	Example	Result
[ratio]	{27% * 10%}	{2.7%}
[length]	{27% * 100pt}	{27pt}
[relative]	{27% * (10% + 100pt)}	{2.7% + 27pt}
[angle]	{27% * 100deg}	{27deg}
[int]	{27% * 2}	{54%}
[float]	{27% * 0.37037}	{10%}
[fraction]	{27% * 3fr}	{0.81fr}

When ratios are displayed in the document, they are rounded to two significant digits for readability.

Implementations

impl Ratio

pub const fn zero() -> Self

A ratio of 0% represented as 0.0.

pub const fn one() -> Self

A ratio of 100% represented as 1.0.

pub const fn new(ratio: f64) -> Self

Create a new ratio from a value, where 1.0 means 100%.

pub const fn get(self) -> f64

Get the underlying ratio.

pub fn is_zero(self) -> bool

Whether the ratio is zero.

pub fn is_one(self) -> bool

Whether the ratio is one.

pub fn abs(self) -> Self

The absolute value of this ratio.

pub fn of<T: Numeric>(self, whole: T) -> T

Return the ratio of the given whole.

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 Ratio

type Output = Rel<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Ratio

type Output = Ratio

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Ratio

fn add_assign(&mut self, other: Ratio)

Performs the += operation.

impl Clone for Ratio

fn clone(&self) -> Ratio

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ratio

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

Formats the value using the given formatter.

impl Default for Ratio

fn default() -> Ratio

Returns the “default value” for a type.

impl Div<Ratio> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Ratio) -> Self

Performs the / operation.

impl Div<f64> for Ratio

type Output = Ratio

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Ratio

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Ratio

fn div_assign(&mut self, other: f64)

Performs the /= operation.

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

fn from(rel: Ratio) -> Self

Converts to this type from the input type.

impl FromValue for Ratio

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

Try to cast the value into an instance of Self.

impl Hash for Ratio

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 Ratio

fn into_value(self) -> Value

Cast this type into a value.

impl Mul<Ratio> for f64

type Output = Ratio

The resulting type after applying the * operator.

fn mul(self, other: Ratio) -> Ratio

Performs the * operation.

impl Mul<f64> for Ratio

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Ratio

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Ratio

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl MulAssign for Ratio

fn mul_assign(&mut self, other: Ratio)

Performs the *= operation.

impl NativeType for Ratio

const NAME: &'static str = "ratio"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Neg for Ratio

type Output = Ratio

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Ratio

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

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

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

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 Ratio

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Sub for Ratio

type Output = Ratio

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Ratio

fn sub_assign(&mut self, other: Ratio)

Performs the -= operation.

impl Copy for Ratio

impl Eq for Ratio

impl StructuralPartialEq for Ratio