Struct Fr

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

Defines how the remaining space in a layout is distributed.

Each fractionally sized element gets space based on the ratio of its fraction to the sum of all fractions.

For more details, also see the [h] and [v] functions and the grid function.

Example

Left #h(1fr) Left-ish #h(2fr) Right

Implementations

impl Fr

pub const fn zero() -> Self

Takes up zero space: 0fr.

pub const fn one() -> Self

Takes up as much space as all other items with this fraction: 1fr.

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

Create a new fraction.

pub const fn get(self) -> f64

Get the underlying number.

pub fn abs(self) -> Self

The absolute value of this fraction.

pub fn share(self, total: Self, remaining: Abs) -> Abs

Determine this fraction’s share in the remaining space.

Trait Implementations

impl Add for Fr

type Output = Fr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Fr

fn add_assign(&mut self, other: Fr)

Performs the += operation.

impl Clone for Fr

fn clone(&self) -> Fr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fr

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

Formats the value using the given formatter.

impl Default for Fr

fn default() -> Fr

Returns the “default value” for a type.

impl Div<f64> for Fr

type Output = Fr

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Fr

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Fr

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl From<Fr> for Spacing

fn from(fr: Fr) -> Self

Converts to this type from the input type.

impl FromValue for Fr

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

Try to cast the value into an instance of Self.

impl Hash for Fr

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 Fr

fn into_value(self) -> Value

Cast this type into a value.

impl Mul<Fr> for f64

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Fr

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Fr

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl NativeType for Fr

const NAME: &'static str = "fraction"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Neg for Fr

type Output = Fr

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Numeric for Fr

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 Ord for Fr

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

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

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

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 Fr

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Sub for Fr

type Output = Fr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Fr

fn sub_assign(&mut self, other: Fr)

Performs the -= operation.

impl Sum for Fr

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Fr

impl Eq for Fr

impl StructuralPartialEq for Fr