Struct geo_types::Rect

pub struct Rect<T> where
    T: CoordNum,  { /* fields omitted */ }

An axis-aligned bounded 2D rectangle whose area is defined by minimum and maximum Coordinates.

The constructors and setters ensure the maximum Coordinate is greater than or equal to the minimum. Thus, a Rects width, height, and area is guaranteed to be greater than or equal to zero.

Note. While Rect implements MapCoords and RotatePoint algorithmic traits, the usage is expected to maintain the axis alignment. In particular, only rotation by integer multiples of 90 degrees, will preserve the original shape. In other cases, the min, and max points are rotated or transformed, and a new rectangle is created (with coordinate swaps to ensure min < max).

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 0., y: 4.},
    Coordinate { x: 3., y: 10.},
);

assert_eq!(3., rect.width());
assert_eq!(6., rect.height());
assert_eq!(
    Coordinate { x: 1.5, y: 7. },
    rect.center()
);

Implementations

impl<T: CoordNum> Rect<T>

pub fn new<C>(c1: C, c2: C) -> Rect<T> where
    C: Into<Coordinate<T>>, 

Creates a new rectangle from two corner coordinates.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 10., y: 20. },
    Coordinate { x: 30., y: 10. }
);
assert_eq!(rect.min(), Coordinate { x: 10., y: 10. });
assert_eq!(rect.max(), Coordinate { x: 30., y: 20. });

pub fn try_new<C>(c1: C, c2: C) -> Result<Rect<T>, InvalidRectCoordinatesError> where
    C: Into<Coordinate<T>>, 

👎 Deprecated since 0.6.2:

Use Rect::new instead, since Rect::try_new will never Error

pub fn min(self) -> Coordinate<T>

Returns the minimum Coordinate of the Rect.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 5., y: 5. },
    Coordinate { x: 15., y: 15. },
);

assert_eq!(rect.min(), Coordinate { x: 5., y: 5. });

pub fn set_min<C>(&mut self, min: C) where
    C: Into<Coordinate<T>>, 

Set the Rect’s minimum coordinate.

Panics

Panics if min’s x/y is greater than the maximum coordinate’s x/y.

pub fn max(self) -> Coordinate<T>

Returns the maximum Coordinate of the Rect.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 5., y: 5. },
    Coordinate { x: 15., y: 15. },
);

assert_eq!(rect.max(), Coordinate { x: 15., y: 15. });

pub fn set_max<C>(&mut self, max: C) where
    C: Into<Coordinate<T>>, 

Set the Rect’s maximum coordinate.

Panics

Panics if max’s x/y is less than the minimum coordinate’s x/y.

pub fn width(self) -> T

Returns the width of the Rect.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 5., y: 5. },
    Coordinate { x: 15., y: 15. },
);

assert_eq!(rect.width(), 10.);

pub fn height(self) -> T

Returns the height of the Rect.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 5., y: 5. },
    Coordinate { x: 15., y: 15. },
);

assert_eq!(rect.height(), 10.);

pub fn to_polygon(self) -> Polygon<T>

Create a Polygon from the Rect.

Examples

use geo_types::{Coordinate, Rect, polygon};

let rect = Rect::new(
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 20. },
);

assert_eq!(
    rect.to_polygon(),
    polygon![
        (x: 0., y: 0.),
        (x: 0., y: 20.),
        (x: 10., y: 20.),
        (x: 10., y: 0.),
        (x: 0., y: 0.),
    ],
);

impl<T: CoordFloat> Rect<T>

pub fn center(self) -> Coordinate<T>

Returns the center Coordinate of the Rect.

Examples

use geo_types::{Coordinate, Rect};

let rect = Rect::new(
    Coordinate { x: 5., y: 5. },
    Coordinate { x: 15., y: 15. },
);

assert_eq!(
    rect.center(),
    Coordinate { x: 10., y: 10. }
);

Trait Implementations

impl<T> AbsDiffEq<Rect<T>> for Rect<T> where
    T: AbsDiffEq<Epsilon = T> + CoordNum,
    T::Epsilon: Copy, 

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{point, Rect};

let a = Rect::new((0.0, 0.0), (10.0, 10.0));
let b = Rect::new((0.0, 0.0), (10.01, 10.0));

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Clone> Clone for Rect<T> where
    T: CoordNum, 

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> where
    T: CoordNum, 

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

Formats the value using the given formatter.

impl<T: CoordNum> From<Rect<T>> for Polygon<T>

fn from(r: Rect<T>) -> Polygon<T>

Performs the conversion.

impl<T: CoordNum> From<Rect<T>> for Geometry<T>

fn from(x: Rect<T>) -> Geometry<T>

Performs the conversion.

impl<T: Hash> Hash for Rect<T> where
    T: CoordNum, 

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, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Rect<T>> for Rect<T> where
    T: CoordNum, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> RelativeEq<Rect<T>> for Rect<T> where
    T: AbsDiffEq<Epsilon = T> + CoordNum + RelativeEq, 

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::Rect;

let a = Rect::new((0.0, 0.0), (10.0, 10.0));
let b = Rect::new((0.0, 0.0), (10.01, 10.0));

approx::assert_relative_eq!(a, b, max_relative=0.1);
approx::assert_relative_ne!(a, b, max_relative=0.0001);

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: CoordNum> TryFrom<Geometry<T>> for Rect<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy> Copy for Rect<T> where
    T: CoordNum, 

impl<T: Eq> Eq for Rect<T> where
    T: CoordNum, 

impl<T> StructuralEq for Rect<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for Rect<T> where
    T: CoordNum,