Enum DefiniteLength 

pub enum DefiniteLength {
    Absolute(AbsoluteLength),
    Relative(Relative),
}

A length with a value: an absolute length, or a fraction of the parent.

Unlike Length, it can’t be auto. Layout resolves a fraction against the parent’s size with DefiniteLength::to_pixels.

Examples

use gpui::{DefiniteLength, Pixels, px, relative};

let half_of_parent = DefiniteLength::from(relative(0.5));
let fixed = DefiniteLength::from(px(10.));
assert_eq!(fixed, DefiniteLength::from(Pixels::from(10.)));
assert_ne!(half_of_parent, fixed);

Variants

Absolute(AbsoluteLength)

A fixed length in pixels or rems.

Relative(Relative)

A fraction of the parent’s size.

Implementations

impl DefiniteLength

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

Converts this length to pixels.

An absolute length converts directly. A fraction is multiplied by base_size, which is the parent’s size along the axis this length applies to. rem_size is the pixel size of one rem.

Examples

let length_in_pixels = DefiniteLength::Absolute(AbsoluteLength::Pixels(px(42.0)));
let length_in_rems = DefiniteLength::Absolute(AbsoluteLength::Rems(rems(2.0)));
let length_as_fraction = DefiniteLength::from(relative(0.5));
let base_size = AbsoluteLength::Pixels(px(100.0));
let rem_size = px(16.0);

assert_eq!(length_in_pixels.to_pixels(base_size, rem_size), Pixels::from(42.0));
assert_eq!(length_in_rems.to_pixels(base_size, rem_size), Pixels::from(32.0));
assert_eq!(length_as_fraction.to_pixels(base_size, rem_size), Pixels::from(50.0));

Trait Implementations

impl Clone for DefiniteLength

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 DefiniteLength

impl Debug for DefiniteLength

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

Formats the value using the given formatter.

impl Default for DefiniteLength

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DefiniteLength

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for DefiniteLength

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

Formats the value using the given formatter.

impl From<AbsoluteLength> for DefiniteLength

fn from(length: AbsoluteLength) -> Self

Converts to this type from the input type.

impl From<DefiniteLength> for Length

fn from(length: DefiniteLength) -> Self

Converts to this type from the input type.

impl From<Pixels> for DefiniteLength

fn from(pixels: Pixels) -> Self

Converts to this type from the input type.

impl From<Relative> for DefiniteLength

fn from(relative: Relative) -> Self

Converts to this type from the input type.

impl From<Rems> for DefiniteLength

fn from(rems: Rems) -> Self

Converts to this type from the input type.

impl IsZero for DefiniteLength

fn is_zero(&self) -> bool

Returns true if this value is zero.

impl JsonSchema for DefiniteLength

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Lerp for DefiniteLength

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

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

impl Neg for DefiniteLength

type Output = DefiniteLength

The resulting type after applying the - operator.

fn neg(self) -> DefiniteLength

Performs the unary - operation.

impl PartialEq for DefiniteLength

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DefiniteLength

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DefiniteLength

impl TryFrom<&str> for DefiniteLength

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.