Struct Rect

pub struct Rect<T> {
    pub left: T,
    pub right: T,
    pub top: T,
    pub bottom: T,
}

An axis-aligned UI rectangle

Fields

left: T

This can represent either the x-coordinate of the starting edge, or the amount of padding on the starting side.

The starting edge is the left edge when working with LTR text, and the right edge when working with RTL text.

right: T

This can represent either the x-coordinate of the ending edge, or the amount of padding on the ending side.

The ending edge is the right edge when working with LTR text, and the left edge when working with RTL text.

top: T

This can represent either the y-coordinate of the top edge, or the amount of padding on the top side.

bottom: T

This can represent either the y-coordinate of the bottom edge, or the amount of padding on the bottom side.

Implementations

impl<T: Add> Rect<T>

pub fn grid_axis_sum(self, axis: AbsoluteAxis) -> <T as Add>::Output

Get either the width or height depending on the AbsoluteAxis passed in

impl<T> Rect<T>

pub fn map<R, F>(self, f: F) -> Rect<R>

where F: Fn(T) -> R,

Applies the function f to the left, right, top, and bottom properties

This is used to transform a Rect<T> into a Rect<R>.

pub fn horizontal_components(self) -> Line<T>

Returns a Line<T> representing the left and right properties of the Rect

pub fn vertical_components(self) -> Line<T>

Returns a Line<T> containing the top and bottom properties of the Rect

impl<T, U> Rect<T>

where T: Add<Output = U> + Copy + Clone,

pub(crate) fn horizontal_axis_sum(&self) -> U

The sum of Rect.start and Rect.end

This is typically used when computing total padding.

NOTE: this is not the width of the rectangle.

pub(crate) fn vertical_axis_sum(&self) -> U

The sum of Rect.top and Rect.bottom

This is typically used when computing total padding.

NOTE: this is not the height of the rectangle.

pub(crate) fn sum_axes(&self) -> Size<U>

Both horizontal_axis_sum and vertical_axis_sum as a Size

NOTE: this is not the width/height of the rectangle.

impl Rect<f32>

pub const ZERO: Rect<f32>

Creates a new Rect with 0.0 as all parameters

pub const fn new(start: f32, end: f32, top: f32, bottom: f32) -> Self

Creates a new Rect

impl Rect<Dimension>

pub const fn from_length(start: f32, end: f32, top: f32, bottom: f32) -> Self

Create a new Rect with Dimension::Length

pub const fn from_percent(start: f32, end: f32, top: f32, bottom: f32) -> Self

Create a new Rect with Dimension::Percent

impl<T: TaffyZero> Rect<T>

pub const fn zero() -> Self

Returns a Rect where the left, right, top, and bottom values are all the zero value of the contained type (e.g. 0.0, Some(0.0), or Dimension::Length(0.0))

impl<T: TaffyAuto> Rect<T>

pub const fn auto() -> Self

Returns a Rect where the left, right, top, and bottom values are all the auto value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyMinContent> Rect<T>

pub const fn min_content() -> Self

Returns a Rect where the left, right, top, and bottom values are all the min_content value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyMaxContent> Rect<T>

pub const fn max_content() -> Self

Returns a Rect where the left, right, top, and bottom values are all the max_content value of the contained type (e.g. Dimension::Auto or LengthPercentageAuto::Auto)

impl<T: TaffyFitContent> Rect<T>

pub fn fit_content(argument: LengthPercentage) -> Self

Returns a Rect where the left, right, top and bottom values are all constant fit_content value of the contained type (e.g. 2.1, Some(2.1), or Dimension::Length(2.1))

impl<T: FromLength> Rect<T>

pub fn length<Input: Into<f32> + Copy>(value: Input) -> Self

Returns a Rect where the left, right, top and bottom values are all the same given absolute length

impl<T: FromPercent> Rect<T>

pub fn percent<Input: Into<f32> + Copy>(percent_value: Input) -> Self

Returns a Rect where the left, right, top and bottom values are all constant percent value of the contained type (e.g. 2.1, Some(2.1), or Dimension::Length(2.1))

Trait Implementations

impl<U, T: Add<U>> Add<Rect<U>> for Rect<T>

type Output = Rect<<T as Add<U>>::Output>

The resulting type after applying the + operator.

fn add(self, rhs: Rect<U>) -> Self::Output

Performs the + operation.

impl<T: Clone> Clone for Rect<T>

fn clone(&self) -> Rect<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Rect<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Rect<T>

fn default() -> Rect<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: FromLength> FromLength for Rect<T>

fn from_length<Input: Into<f32> + Copy>(value: Input) -> Self

Converts into an Into<f32> into Self

impl<T: FromPercent> FromPercent for Rect<T>

fn from_percent<Input: Into<f32> + Copy>(percent: Input) -> Self

Converts into an Into<f32> into Self

impl<T: PartialEq> PartialEq for Rect<T>

fn eq(&self, other: &Rect<T>) -> 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<Out: TaffyZero, T: ResolveOrZero<Option<f32>, Out>> ResolveOrZero<Option<f32>, Rect<Out>> for Rect<T>

fn resolve_or_zero(self, context: Option<f32>) -> Rect<Out>

Converts any parent-relative values for Rect into an absolute Rect

impl<In: Copy, Out: TaffyZero, T: ResolveOrZero<In, Out>> ResolveOrZero<Size<In>, Rect<Out>> for Rect<T>

fn resolve_or_zero(self, context: Size<In>) -> Rect<Out>

Converts any parent-relative values for Rect into an absolute Rect

impl<T> Serialize for Rect<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TaffyAuto> TaffyAuto for Rect<T>

const AUTO: Rect<T>

The auto value for type implementing TaffyAuto

impl<T: TaffyFitContent> TaffyFitContent for Rect<T>

fn fit_content(argument: LengthPercentage) -> Self

Converts a LengthPercentage into Self

impl<T: TaffyMaxContent> TaffyMaxContent for Rect<T>

const MAX_CONTENT: Rect<T>

The max_content value for type implementing TaffyZero

impl<T: TaffyMinContent> TaffyMinContent for Rect<T>

const MIN_CONTENT: Rect<T>

The min_content value for type implementing TaffyZero

impl<T: TaffyZero> TaffyZero for Rect<T>

const ZERO: Rect<T>

The zero value for type implementing TaffyZero

impl<T: Copy> Copy for Rect<T>

impl<T: Eq> Eq for Rect<T>

impl<T> StructuralPartialEq for Rect<T>