# Struct euclid::Rect

``````#[repr(C)]pub struct Rect<T, U> {
pub origin: Point2D<T, U>,
pub size: Size2D<T, U>,
}``````
Expand description

A 2d Rectangle optionally tagged with a unit.

## §Representation

`Rect` is represented by an origin point and a size.

See `Rect` for a rectangle represented by two endpoints.

## §Empty rectangle

A rectangle is considered empty (see `is_empty`) if any of the following is true:

• it’s area is empty,
• it’s area is negative (`size.x < 0` or `size.y < 0`),
• it contains NaNs.

## Fields§

§`origin: Point2D<T, U>`§`size: Size2D<T, U>`

## Implementations§

source§

source

Constructor.

source§

### impl<T, U> Rect<T, U>where T: Zero,

source

#### pub fn zero() -> Self

Constructor, setting all sides to zero.

source

#### pub fn from_size(size: Size2D<T, U>) -> Self

Creates a rect of the given size, at offset zero.

source§

### impl<T, U> Rect<T, U>where T: Copy + Add<T, Output = T>,

source

source

source

source

source

source

source

source

source

source

source

#### pub fn translate(&self, by: Vector2D<T, U>) -> Self

Returns the same rectangle, translated by a vector.

source

source§

### impl<T, U> Rect<T, U>where T: Copy + PartialOrd + Add<T, Output = T>,

source

#### pub fn contains(&self, p: Point2D<T, U>) -> bool

Returns true if this rectangle contains the point. Points are considered in the rectangle if they are on the left or top edge, but outside if they are on the right or bottom edge.

source

source§

source

source§

source

source§

### impl<T, U> Rect<T, U>where T: Copy + Zero + PartialOrd + Add<T, Output = T>,

source

#### pub fn contains_rect(&self, rect: &Self) -> bool

Returns true if this rectangle contains the interior of rect. Always returns true if rect is empty, and always returns false if rect is nonempty but this rectangle is empty.

source§

### impl<T, U> Rect<T, U>where T: Copy + Zero + PartialOrd + Add<T, Output = T> + Sub<T, Output = T>,

source

#### pub fn inner_rect(&self, offsets: SideOffsets2D<T, U>) -> Self

Calculate the size and position of an inner rectangle.

Subtracts the side offsets from all sides. The horizontal and vertical offsets must not be larger than the original side length. This method assumes y oriented downward.

source§

### impl<T, U> Rect<T, U>where T: Copy + Add<T, Output = T> + Sub<T, Output = T>,

source

#### pub fn outer_rect(&self, offsets: SideOffsets2D<T, U>) -> Self

Calculate the size and position of an outer rectangle.

Add the offsets to all sides. The expanded rectangle is returned. This method assumes y oriented downward.

source§

### impl<T, U> Rect<T, U>where T: Copy + Zero + PartialOrd + Sub<T, Output = T>,

source

#### pub fn from_points<I>(points: I) -> Selfwhere I: IntoIterator, I::Item: Borrow<Point2D<T, U>>,

Returns the smallest rectangle defined by the top/bottom/left/right-most points provided as parameter.

Note: This function has a behavior that can be surprising because the right-most and bottom-most points are exactly on the edge of the rectangle while the `contains` function is has exclusive semantic on these edges. This means that the right-most and bottom-most points provided to `from_points` will count as not contained by the rect. This behavior may change in the future.

source§

### impl<T, U> Rect<T, U>where T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,

source

#### pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this rectangle and another rectangle.

source§

source

source§

source

source§

source

source§

source

source§

source

source§

source

source§

### impl<T: Copy, U> Rect<T, U>

source

#### pub fn to_untyped(&self) -> Rect<T, UnknownUnit>

Drop the units, preserving only the numeric value.

source

#### pub fn from_untyped(r: &Rect<T, UnknownUnit>) -> Rect<T, U>

Tag a unitless value with units.

source

Cast the unit

source§

### impl<T: NumCast + Copy, U> Rect<T, U>

source

#### pub fn cast<NewT: NumCast>(&self) -> Rect<NewT, U>

Cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), round_in or round_out() before casting.

source

#### pub fn try_cast<NewT: NumCast>(&self) -> Option<Rect<NewT, U>>

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), round_in or round_out() before casting.

source

#### pub fn to_f32(&self) -> Rect<f32, U>

Cast into an `f32` rectangle.

source

#### pub fn to_f64(&self) -> Rect<f64, U>

Cast into an `f64` rectangle.

source

#### pub fn to_usize(&self) -> Rect<usize, U>

Cast into an `usize` rectangle, truncating decimals if any.

When casting from floating point rectangles, it is worth considering whether to `round()`, `round_in()` or `round_out()` before the cast in order to obtain the desired conversion behavior.

source

#### pub fn to_u32(&self) -> Rect<u32, U>

Cast into an `u32` rectangle, truncating decimals if any.

When casting from floating point rectangles, it is worth considering whether to `round()`, `round_in()` or `round_out()` before the cast in order to obtain the desired conversion behavior.

source

#### pub fn to_u64(&self) -> Rect<u64, U>

Cast into an `u64` rectangle, truncating decimals if any.

When casting from floating point rectangles, it is worth considering whether to `round()`, `round_in()` or `round_out()` before the cast in order to obtain the desired conversion behavior.

source

#### pub fn to_i32(&self) -> Rect<i32, U>

Cast into an `i32` rectangle, truncating decimals if any.

When casting from floating point rectangles, it is worth considering whether to `round()`, `round_in()` or `round_out()` before the cast in order to obtain the desired conversion behavior.

source

#### pub fn to_i64(&self) -> Rect<i64, U>

Cast into an `i64` rectangle, truncating decimals if any.

When casting from floating point rectangles, it is worth considering whether to `round()`, `round_in()` or `round_out()` before the cast in order to obtain the desired conversion behavior.

source§

### impl<T: Floor + Ceil + Round + Add<T, Output = T> + Sub<T, Output = T>, U> Rect<T, U>

source

#### pub fn round(&self) -> Self

Return a rectangle with edges rounded to integer coordinates, such that the returned rectangle has the same set of pixel centers as the original one. Edges at offset 0.5 round up. Suitable for most places where integral device coordinates are needed, but note that any translation should be applied first to avoid pixel rounding errors. Note that this is not rounding to nearest integer if the values are negative. They are always rounding as floor(n + 0.5).

##### §Usage notes

Note, that when using with floating-point `T` types that method can significantly loose precision for large values, so if you need to call this method very often it is better to use `Box2D`.

source

#### pub fn round_in(&self) -> Self

Return a rectangle with edges rounded to integer coordinates, such that the original rectangle contains the resulting rectangle.

##### §Usage notes

Note, that when using with floating-point `T` types that method can significantly loose precision for large values, so if you need to call this method very often it is better to use `Box2D`.

source

#### pub fn round_out(&self) -> Self

Return a rectangle with edges rounded to integer coordinates, such that the original rectangle is contained in the resulting rectangle.

##### §Usage notes

Note, that when using with floating-point `T` types that method can significantly loose precision for large values, so if you need to call this method very often it is better to use `Box2D`.

## Trait Implementations§

source§

### impl<T: Clone, U> Clone for Rect<T, U>

source§

#### fn clone(&self) -> Self

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, U> Debug for Rect<T, U>

source§

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

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

### impl<T: Default, U> Default for Rect<T, U>

source§

#### fn default() -> Self

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

### impl<'de, T, U> Deserialize<'de> for Rect<T, U>where T: Deserialize<'de>,

source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

### impl<T: Copy + Div, U1, U2> Div<Scale<T, U1, U2>> for Rect<T, U2>

§

#### type Output = Rect<<T as Div>::Output, U1>

The resulting type after applying the `/` operator.
source§

#### fn div(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the `/` operation. Read more
source§

### impl<T: Copy + Div, U> Div<T> for Rect<T, U>

§

#### type Output = Rect<<T as Div>::Output, U>

The resulting type after applying the `/` operator.
source§

#### fn div(self, scale: T) -> Self::Output

Performs the `/` operation. Read more
source§

### impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Rect<T, U>

source§

#### fn div_assign(&mut self, scale: Scale<T, U, U>)

Performs the `/=` operation. Read more
source§

### impl<T: Copy + DivAssign, U> DivAssign<T> for Rect<T, U>

source§

#### fn div_assign(&mut self, scale: T)

Performs the `/=` operation. Read more
source§

### impl<T, U> From<Size2D<T, U>> for Rect<T, U>where T: Zero,

source§

#### fn from(size: Size2D<T, U>) -> Self

Converts to this type from the input type.
source§

### impl<T: Hash, U> Hash for Rect<T, U>

source§

#### fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

#### fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given `Hasher`. Read more
source§

### impl<T: Copy + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Rect<T, U1>

§

#### type Output = Rect<<T as Mul>::Output, U2>

The resulting type after applying the `*` operator.
source§

#### fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the `*` operation. Read more
source§

### impl<T: Copy + Mul, U> Mul<T> for Rect<T, U>

§

#### type Output = Rect<<T as Mul>::Output, U>

The resulting type after applying the `*` operator.
source§

#### fn mul(self, scale: T) -> Self::Output

Performs the `*` operation. Read more
source§

### impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Rect<T, U>

source§

#### fn mul_assign(&mut self, scale: Scale<T, U, U>)

Performs the `*=` operation. Read more
source§

### impl<T: Copy + MulAssign, U> MulAssign<T> for Rect<T, U>

source§

#### fn mul_assign(&mut self, scale: T)

Performs the `*=` operation. Read more
source§

### impl<T: PartialEq, U> PartialEq for Rect<T, U>

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

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

### impl<T, U> Serialize for Rect<T, U>where T: Serialize,

source§

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

Serialize this value into the given Serde serializer. Read more
source§

source§

§

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

#### 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 Twhere U: Into<T>,

§

#### 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 Twhere U: TryFrom<T>,

§

#### 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.
source§