Struct taffy::geometry::Rect

source ·
pub struct Rect<T> {
    pub left: T,
    pub right: T,
    pub top: T,
    pub bottom: T,
}
Expand description

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§

source§

impl<T: Add> Rect<T>

source

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

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

source§

impl<T> Rect<T>

source

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>.

source

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

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

source

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

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

source§

impl Rect<f32>

source

pub const ZERO: Rect<f32> = _

Creates a new Rect with 0.0 as all parameters

source

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

Creates a new Rect

source§

impl Rect<Dimension>

source

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

Create a new Rect with Dimension::Length

source

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

Create a new Rect with Dimension::Percent

source§

impl<T: TaffyZero> Rect<T>

source

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))

source§

impl<T: TaffyAuto> Rect<T>

source

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)

source§

impl<T: TaffyMinContent> Rect<T>

source

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)

source§

impl<T: TaffyMaxContent> Rect<T>

source

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)

source§

impl<T: TaffyFitContent> Rect<T>

source

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))

source§

impl<T: FromLength> Rect<T>

source

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

source§

impl<T: FromPercent> Rect<T>

source

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§

source§

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

source§

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

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Rect<T>

Returns the “default value” for a type. Read more
source§

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

source§

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

Converts into an Into<f32> into Self
source§

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

source§

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

Converts into an Into<f32> into Self
source§

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

source§

fn eq(&self, other: &Rect<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

const AUTO: Rect<T> = _

The auto value for type implementing TaffyAuto
source§

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

source§

fn fit_content(argument: LengthPercentage) -> Self

Converts a LengthPercentage into Self
source§

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

source§

const MAX_CONTENT: Rect<T> = _

The max_content value for type implementing TaffyZero
source§

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

source§

const MIN_CONTENT: Rect<T> = _

The min_content value for type implementing TaffyZero
source§

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

source§

const ZERO: Rect<T> = _

The zero value for type implementing TaffyZero
source§

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

source§

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

source§

impl<T> StructuralPartialEq for Rect<T>

Auto Trait Implementations§

§

impl<T> Freeze for Rect<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Rect<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rect<T>
where T: Send,

§

impl<T> Sync for Rect<T>
where T: Sync,

§

impl<T> Unpin for Rect<T>
where T: Unpin,

§

impl<T> UnwindSafe for Rect<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.