Struct Rect 

pub struct Rect<T = f64>
where
    T: CoordNum,
{ /* private fields */ }

Available on crate feature geo-types only.

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

The constructors and setters ensure the maximum Coord 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::{coord, Rect};

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

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

Implementations

impl<T> Rect<T>

where T: CoordNum,

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

where C: Into<Coord<T>>,

Creates a new rectangle from two corner coordinates.

Coords are stored and returned (by iterators) in CCW order

Examples

use geo_types::{coord, Rect};

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

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

where C: Into<Coord<T>>,

👎Deprecated since 0.6.2: Use Rect::new instead, since Rect::try_new will never Error

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

Returns the minimum Coord of the Rect.

Examples

use geo_types::{coord, Rect};

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

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

pub fn set_min<C>(&mut self, min: C)

where C: Into<Coord<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) -> Coord<T>

Returns the maximum Coord of the Rect.

Examples

use geo_types::{coord, Rect};

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

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

pub fn set_max<C>(&mut self, max: C)

where C: Into<Coord<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::{coord, Rect};

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

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

pub fn height(self) -> T

Returns the height of the Rect.

Examples

use geo_types::{coord, Rect};

let rect = Rect::new(
    coord! { x: 5., y: 5. },
    coord! { 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::{coord, Rect, polygon};

let rect = Rect::new(
    coord! { x: 0., y: 0. },
    coord! { x: 1., y: 2. },
);

// Output is CCW
assert_eq!(
    rect.to_polygon(),
    polygon![
        (x: 1., y: 0.),
        (x: 1., y: 2.),
        (x: 0., y: 2.),
        (x: 0., y: 0.),
        (x: 1., y: 0.),
    ],
);

pub fn to_lines(&self) -> [Line<T>; 4]

pub fn split_x(self) -> [Rect<T>; 2]

Split a rectangle into two rectangles along the X-axis with equal widths.

Examples

let rect = geo_types::Rect::new(
    geo_types::coord! { x: 0., y: 0. },
    geo_types::coord! { x: 4., y: 4. },
);

let [rect1, rect2] = rect.split_x();

assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 0. },
        geo_types::coord! { x: 2., y: 4. },
    ),
    rect1,
);
assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 2., y: 0. },
        geo_types::coord! { x: 4., y: 4. },
    ),
    rect2,
);

pub fn split_y(self) -> [Rect<T>; 2]

Split a rectangle into two rectangles along the Y-axis with equal heights.

Examples

let rect = geo_types::Rect::new(
    geo_types::coord! { x: 0., y: 0. },
    geo_types::coord! { x: 4., y: 4. },
);

let [rect1, rect2] = rect.split_y();

assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 0. },
        geo_types::coord! { x: 4., y: 2. },
    ),
    rect1,
);
assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 2. },
        geo_types::coord! { x: 4., y: 4. },
    ),
    rect2,
);

impl<T> Rect<T>

where T: CoordFloat,

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

Returns the center Coord of the Rect.

Examples

use geo_types::{coord, Rect};

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

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

Trait Implementations

impl<T> Clone for Rect<T>

where T: Clone + CoordNum,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Rect<T>

where T: CoordNum,

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

Formats the value using the given formatter.

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

where T: CoordNum,

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

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

impl<'a, T> GeometryTrait for &'a Rect<T>

where T: CoordNum + 'a,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<&'a Rect<T> as GeometryTrait>::T> where &'a Rect<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> GeometryTrait for Rect<T>

where T: CoordNum,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<Rect<T> as GeometryTrait>::T> where Rect<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> Hash for Rect<T>

where T: Hash + CoordNum,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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> PartialEq for Rect<T>

where T: PartialEq + CoordNum,

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<'a, T> RectTrait for &'a Rect<T>

where T: CoordNum + 'a,

type CoordType<'b> = Coord<T> where &'a Rect<T>: 'b

The type of each underlying coordinate, which implements CoordTrait

fn min(&self) -> <&'a Rect<T> as RectTrait>::CoordType<'_>

The minimum coordinate of this Rect

fn max(&self) -> <&'a Rect<T> as RectTrait>::CoordType<'_>

The maximum coordinate of this Rect

impl<T> RectTrait for Rect<T>

where T: CoordNum,

type CoordType<'b> = Coord<T> where Rect<T>: 'b

The type of each underlying coordinate, which implements CoordTrait

fn min(&self) -> <Rect<T> as RectTrait>::CoordType<'_>

The minimum coordinate of this Rect

fn max(&self) -> <Rect<T> as RectTrait>::CoordType<'_>

The maximum coordinate of this Rect

impl<T> ToWkt<T> for Rect<T>

where T: CoordNum + Display,

Examples

use geo_types::{coord, Rect};
use wkt::ToWkt;

let rect: Rect<f64> = Rect::new(coord!(x: 4., y: 4.), coord!(x: 8., y: 8.));

assert_eq!(rect.wkt_string(), "POLYGON((8 4,8 8,4 8,4 4,8 4))");

fn to_wkt(&self) -> Wkt<T>

Converts the value of self to an Wkt struct.

fn write_wkt(&self, writer: impl Write) -> Result<(), Error>

Write a WKT string to a File, or anything else that implements Write.

fn wkt_string(&self) -> String

Serialize as a WKT string

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

where T: CoordNum,

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<Rect<T>, <Rect<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Wkt<T>> for Rect<T>

where T: CoordNum,

Fallibly convert this WKT primitive into this geo_types primitive

type Error = Error

The type returned in the event of a conversion error.

fn try_from(wkt: Wkt<T>) -> Result<Rect<T>, <Rect<T> as TryFrom<Wkt<T>>>::Error>

Performs the conversion.

impl<T> TryFromWkt<T> for Rect<T>

where T: CoordNum + FromStr + Default,

type Error = Error

fn try_from_wkt_str( wkt_str: &str, ) -> Result<Rect<T>, <Rect<T> as TryFromWkt<T>>::Error>

Examples

fn try_from_wkt_reader( wkt_reader: impl Read, ) -> Result<Rect<T>, <Rect<T> as TryFromWkt<T>>::Error>

Examples

impl<T> Copy for Rect<T>

where T: Copy + CoordNum,

impl<T> Eq for Rect<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for Rect<T>

where T: CoordNum,