Struct Size 

#[repr(C)]
pub struct Size<T: Clone + Debug + Default + PartialEq> {
    pub width: T,
    pub height: T,
}

A width and height, such as the size of a window or an element.

Size<Pixels> holds layout sizes in logical pixels. Size<Length> holds style values, which can also be auto or a fraction of the parent. Size<DevicePixels> holds whole physical pixels, such as the size of an image. Construct a size with size.

Examples

use gpui::{px, size};

let window = size(px(800.), px(600.));
assert_eq!(window.width, px(800.));
assert_eq!(window.height, px(600.));

Fields

width: T

The width, along the horizontal axis.

height: T

The height, along the vertical axis.

Implementations

impl<T: Clone + Debug + Default + PartialEq> Size<T>

pub fn new(width: T, height: T) -> Self

Creates a size from its width and height. Same as size.

Examples

use gpui::Size;

let s = Size::new(10, 20);
assert_eq!(s.width, 10);
assert_eq!(s.height, 20);

impl<T> Size<T>

where T: Clone + Debug + Default + PartialEq,

pub fn map<U>(&self, f: impl Fn(T) -> U) -> Size<U>

where U: Clone + Debug + Default + PartialEq,

Returns a new size with f applied to the width and the height.

Examples

let my_size = Size { width: 10, height: 20 };
let my_new_size = my_size.map(|dimension| dimension as f32 * 1.5);
assert_eq!(my_new_size, Size { width: 15.0, height: 30.0 });

impl<T> Size<T>

where T: Clone + Debug + Default + PartialEq + Half,

pub fn center(&self) -> Point<T>

Returns the point at the center of a box of this size, measured from (0, 0).

Examples

assert_eq!(size(px(100.), px(40.)).center(), point(px(50.), px(20.)));

pub fn at_anchor(&self, anchor: Anchor) -> Point<T>

Returns the point at anchor on the edge or corner of a box of this size.

The box’s top left corner is (0, 0), so Anchor::BottomRight returns the size itself.

Examples

let s = size(px(100.), px(40.));
assert_eq!(s.at_anchor(Anchor::BottomCenter), point(px(50.), px(40.)));
assert_eq!(s.at_anchor(Anchor::BottomRight), point(px(100.), px(40.)));

impl Size<Pixels>

pub fn scale(&self, factor: f32) -> Size<ScaledPixels>

Multiplies the width and height by factor, producing ScaledPixels.

Examples

let size = Size { width: Pixels::from(100.0), height: Pixels::from(50.0) };
let scaled_size = size.scale(2.0);
assert_eq!(scaled_size, Size { width: ScaledPixels::from(200.0), height: ScaledPixels::from(100.0) });

impl<T> Size<T>

where T: PartialOrd + Clone + Debug + Default + PartialEq,

pub fn max(&self, other: &Self) -> Self

Returns a size with the larger width and the larger height of self and other.

Examples

let size1 = Size { width: 30, height: 40 };
let size2 = Size { width: 50, height: 20 };
assert_eq!(size1.max(&size2), Size { width: 50, height: 40 });

pub fn min(&self, other: &Self) -> Self

Returns a size with the smaller width and the smaller height of self and other.

Examples

let size1 = Size { width: 30, height: 40 };
let size2 = Size { width: 50, height: 20 };
assert_eq!(size1.min(&size2), Size { width: 30, height: 20 });

impl Size<Length>

pub fn full() -> Self

Returns a size whose width and height are both relative(1.), filling the parent.

Examples

let full = Size::<Length>::full();
assert_eq!(full.width, Length::Definite(DefiniteLength::from(relative(1.))));
assert_eq!(full.height, Length::Definite(DefiniteLength::from(relative(1.))));

impl Size<Length>

pub fn auto() -> Self

Returns a size whose width and height are both Length::Auto.

With auto in both dimensions, layout sizes the element from its content.

Examples

let auto = Size::<Length>::auto();
assert_eq!(auto.width, Length::Auto);
assert_eq!(auto.height, Length::Auto);

impl Size<DevicePixels>

pub fn to_pixels(self, scale_factor: f32) -> Size<Pixels>

Converts this size from device pixels to logical pixels by dividing by scale_factor.

Examples

let device = size(DevicePixels(200), DevicePixels(100));
assert_eq!(device.to_pixels(2.), size(px(100.), px(50.)));

impl Size<Pixels>

pub fn to_device_pixels(self, scale_factor: f32) -> Size<DevicePixels>

Converts this size from logical pixels to device pixels.

Multiplies each side by scale_factor and rounds it to the nearest whole device pixel.

Examples

let logical = size(px(100.), px(50.3));
assert_eq!(logical.to_device_pixels(2.), size(DevicePixels(200), DevicePixels(101)));

Trait Implementations

impl<T> Add for Size<T>

where T: Add<Output = T> + Clone + Debug + Default + PartialEq,

type Output = Size<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Along for Size<T>

where T: Clone + Debug + Default + PartialEq,

type Unit = T

The type of the value along each axis.

fn along(&self, axis: Axis) -> T

Returns the value along axis.

fn apply_along(&self, axis: Axis, f: impl FnOnce(T) -> T) -> Self

Returns a copy with f applied to the value along axis. The other axis is unchanged.

impl<T: Clone + Clone + Debug + Default + PartialEq> Clone for Size<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Clone + Debug + Default + PartialEq> Copy for Size<T>

impl<T> Debug for Size<T>

where T: Clone + Debug + Default + PartialEq,

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

Formats the value using the given formatter.

impl<T: Default + Clone + Debug + Default + PartialEq> Default for Size<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Size<T>

where T: Deserialize<'de> + Clone + Debug + Default + PartialEq,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Clone + Debug + Default + PartialEq + Display> Display for Size<T>

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

Formats the value using the given formatter.

impl<T, __derive_more_Rhs> Div<__derive_more_Rhs> for Size<T>

where T: Div<__derive_more_Rhs, Output = T> + Clone + Debug + Default + PartialEq, __derive_more_Rhs: Copy,

type Output = Size<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Eq for Size<T>

where T: Eq + Clone + Debug + Default + PartialEq,

impl<T: Clone + Debug + Default + PartialEq> From<Point<T>> for Size<T>

fn from(point: Point<T>) -> Self

Converts to this type from the input type.

impl From<Size<Pixels>> for Size<DefiniteLength>

fn from(size: Size<Pixels>) -> Self

Converts to this type from the input type.

impl From<Size<Pixels>> for Size<AbsoluteLength>

fn from(size: Size<Pixels>) -> Self

Converts to this type from the input type.

impl From<Size<Pixels>> for Size<AvailableSpace>

fn from(size: Size<Pixels>) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<Size<T>> for Point<T>

fn from(size: Size<T>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size<T>> for Size<U>

where T: Into<U>, U: Clone + Debug + Default + PartialEq,

fn from(taffy_size: TaffySize<T>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size<T>> for Size<U>

where T: Into<U> + Clone + Debug + Default + PartialEq,

fn from(size: Size<T>) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<SizeRefinement<T>> for Size<T>

where Option<T>: Clone,

fn from(value: SizeRefinement<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + Clone + Debug + Default + PartialEq> Hash for Size<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<T> IsZero for Size<T>

where T: IsZero + Clone + Debug + Default + PartialEq,

fn is_zero(&self) -> bool

Returns true if this value is zero.

impl<T: Lerp + Clone + Debug + Default + PartialEq> Lerp for Size<T>

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

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

impl<T, Rhs> Mul<Rhs> for Size<T>

where T: Mul<Rhs, Output = Rhs> + Clone + Debug + Default + PartialEq, Rhs: Clone + Debug + Default + PartialEq,

type Output = Size<Rhs>

The resulting type after applying the * operator.

fn mul(self, rhs: Rhs) -> Self::Output

Performs the * operation.

impl<T, S> MulAssign<S> for Size<T>

where T: Mul<S, Output = T> + Clone + Debug + Default + PartialEq, S: Clone,

fn mul_assign(&mut self, rhs: S)

Performs the *= operation.

impl<T: Clone + Debug + Default + PartialEq + Neg<Output = T>> Neg for Size<T>

type Output = Size<T>

The resulting type after applying the - operator.

fn neg(self) -> Size<T>

Performs the unary - operation.

impl<T: PartialEq + Clone + Debug + Default + PartialEq> PartialEq for Size<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Clone + Debug + Default + PartialEq> Refineable for Size<T>

where Option<T>: Clone,

type Refinement = SizeRefinement<T>

fn refine(&mut self, refinement: &Self::Refinement)

Applies the given refinement to this instance, modifying it in place.

fn refined(self, refinement: Self::Refinement) -> Self

Returns a new instance with the refinement applied, equivalent to cloning self and calling refine on it.

fn is_superset_of(&self, refinement: &Self::Refinement) -> bool

Returns true if this instance would contain all values from the refinement.

fn subtract(&self, refinement: &Self::Refinement) -> Self::Refinement

Returns a refinement that represents the difference between this instance and the given refinement.

fn from_cascade(cascade: &Cascade<Self>) -> Self

where Self: Sized + Default,

Creates an instance from a cascade by merging all refinements atop the default value.

impl<T> Serialize for Size<T>

where T: Serialize + Clone + Debug + Default + PartialEq,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq + Clone + Debug + Default + PartialEq> StructuralPartialEq for Size<T>

impl<T> Sub for Size<T>

where T: Sub<Output = T> + Clone + Debug + Default + PartialEq,

type Output = Size<T>

The resulting type after applying the - operator.

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

Performs the - operation.