Struct Relative 

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

A length given as a fraction of a reference length.

1.0 is the full reference length and 0.5 is half of it. Fractions can be negative or greater than 1.0. Create one with relative. The reference length is supplied when the value is resolved, for example by Relative::to_pixels. Relative displays as a percentage, so relative(0.5) shows as 50%.

Examples

use gpui::{AbsoluteLength, Relative, px, rems};

let half = Relative::from(0.5);
assert_eq!(half.to_pixels(AbsoluteLength::Rems(rems(2.)), px(16.)), px(16.));
let base_size = AbsoluteLength::Pixels(px(200.0));

assert_eq!(half.to_pixels(base_size, px(16.0)), px(100.0));
assert_eq!(half.to_string(), "50%");

Implementations

impl Relative

pub const ZERO: Self

A fraction of zero.

pub fn as_f32(self) -> f32

Returns the raw fraction.

pub fn to_pixels(self, base_size: AbsoluteLength, rem_size: Pixels) -> Pixels

Resolves this fraction of base_size to pixels.

When base_size is in rems, rem_size gives the pixel size of one rem.

Examples

let base = AbsoluteLength::Rems(rems(2.));
assert_eq!(relative(0.5).to_pixels(base, px(16.)), px(16.));

Trait Implementations

impl Add for Relative

type Output = Relative

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Relative

fn add_assign(&mut self, rhs: Relative)

Performs the += operation.

impl Clone for Relative

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Relative

impl Debug for Relative

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

Formats the value using the given formatter.

impl Default for Relative

fn default() -> Self

Returns the “default value” for a type.

impl Display for Relative

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

Formats the value using the given formatter.

impl<__derive_more_Rhs> Div<__derive_more_Rhs> for Relative

where f32: Div<__derive_more_Rhs, Output = f32>,

type Output = Relative

The resulting type after applying the / operator.

fn div(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the / operation.

impl From<Relative> for DefiniteLength

fn from(relative: Relative) -> Self

Converts to this type from the input type.

impl From<Relative> for Length

fn from(relative: Relative) -> Self

Converts to this type from the input type.

impl From<f32> for Relative

fn from(fraction: f32) -> Self

Converts to this type from the input type.

impl Half for Relative

fn half(&self) -> Self

Returns half of this value.

impl IsZero for Relative

fn is_zero(&self) -> bool

Returns true if this value is zero.

impl Lerp for Relative

fn lerp(&self, to: &Self, delta: f32) -> Self

Returns the value delta of the way from self to to.

impl<__derive_more_Rhs> Mul<__derive_more_Rhs> for Relative

where f32: Mul<__derive_more_Rhs, Output = f32>,

type Output = Relative

The resulting type after applying the * operator.

fn mul(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the * operation.

impl Neg for Relative

type Output = Relative

The resulting type after applying the - operator.

fn neg(self) -> Relative

Performs the unary - operation.

impl PartialEq for Relative

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Relative

impl Sub for Relative

type Output = Relative

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<&str> for Relative

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.