Struct Rect 

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

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. });

Examples found in repository

examples/advanced_spatial.rs (line 158)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("=== Advanced Spatial Operations Demo ===\n");

    // Create an in-memory database
    let mut db = Spatio::memory()?;

    // ========================================
    // 1. Distance Calculations
    // ========================================
    println!("1. Distance Calculations");
    println!("{}", "=".repeat(50));

    let new_york = Point::new(-74.0060, 40.7128);
    let los_angeles = Point::new(-118.2437, 34.0522);
    let london = Point::new(-0.1278, 51.5074);

    // Calculate distances using different metrics
    let dist_haversine = distance_between(&new_york, &los_angeles, DistanceMetric::Haversine);
    let dist_geodesic = distance_between(&new_york, &los_angeles, DistanceMetric::Geodesic);
    let dist_rhumb = distance_between(&new_york, &los_angeles, DistanceMetric::Rhumb);

    println!("NYC to LA:");
    println!("  Haversine:  {:.2} km", dist_haversine / 1000.0);
    println!("  Geodesic:   {:.2} km", dist_geodesic / 1000.0);
    println!("  Rhumb:      {:.2} km", dist_rhumb / 1000.0);

    // Using the database method
    let db_distance = db.distance_between(&new_york, &london, DistanceMetric::Haversine)?;
    println!("\nNYC to London: {:.2} km", db_distance / 1000.0);

    // ========================================
    // 2. K-Nearest-Neighbors (KNN)
    // ========================================
    println!("\n2. K-Nearest-Neighbors Query");
    println!("{}", "=".repeat(50));

    // Insert major cities
    let cities = vec![
        (Point::new(-74.0060, 40.7128), "New York", "USA"),
        (Point::new(-118.2437, 34.0522), "Los Angeles", "USA"),
        (Point::new(-87.6298, 41.8781), "Chicago", "USA"),
        (Point::new(-95.3698, 29.7604), "Houston", "USA"),
        (Point::new(-75.1652, 39.9526), "Philadelphia", "USA"),
        (Point::new(-122.4194, 37.7749), "San Francisco", "USA"),
        (Point::new(-0.1278, 51.5074), "London", "UK"),
        (Point::new(2.3522, 48.8566), "Paris", "France"),
        (Point::new(139.6917, 35.6895), "Tokyo", "Japan"),
    ];

    for (point, name, country) in &cities {
        let data = format!("{},{}", name, country);
        db.insert_point("world_cities", point, data.as_bytes(), None)?;
    }

    // Find 3 nearest cities to a query point (somewhere in New Jersey)
    let query_point = Point::new(-74.1719, 40.7357);
    let nearest = db.knn(
        "world_cities",
        &query_point,
        3,
        500_000.0, // Search within 500km
        DistanceMetric::Haversine,
    )?;

    println!("3 nearest cities to query point:");
    for (i, (_point, data, distance)) in nearest.iter().enumerate() {
        let city_info = String::from_utf8_lossy(data);
        println!(
            "  {}. {} ({:.2} km away)",
            i + 1,
            city_info,
            distance / 1000.0
        );
    }

    // ========================================
    // 3. Polygon Queries
    // ========================================
    println!("\n3. Polygon Queries");
    println!("{}", "=".repeat(50));

    // Define a polygon covering parts of the eastern US
    use geo::polygon;
    let east_coast_polygon = polygon![
        (x: -80.0, y: 35.0),  // South
        (x: -70.0, y: 35.0),  // Southeast
        (x: -70.0, y: 45.0),  // Northeast
        (x: -80.0, y: 45.0),  // Northwest
        (x: -80.0, y: 35.0),  // Close the polygon
    ];
    let east_coast_polygon: Polygon = east_coast_polygon.into();

    let cities_in_polygon = db.query_within_polygon("world_cities", &east_coast_polygon, 100)?;

    println!("Cities within East Coast polygon:");
    for (point, data) in &cities_in_polygon {
        let city_info = String::from_utf8_lossy(data);
        println!("  - {} at ({:.4}, {:.4})", city_info, point.x(), point.y());
    }

    // ========================================
    // 4. Bounding Box Operations
    // ========================================
    println!("\n4. Bounding Box Operations");
    println!("{}", "=".repeat(50));

    // Create a bounding box around the New York area
    let ny_bbox = bounding_box(-74.5, 40.5, -73.5, 41.0)?;
    println!("NY Area Bounding Box: {:?}", ny_bbox);

    // Find cities in bounding box
    let cities_in_bbox = db.find_within_bounds("world_cities", 40.5, -74.5, 41.0, -73.5, 100)?;
    println!("\nCities in NY area bounding box:");
    for (_point, data) in &cities_in_bbox {
        let city_info = String::from_utf8_lossy(data);
        println!("  - {}", city_info);
    }

    // ========================================
    // 5. Convex Hull
    // ========================================
    println!("\n5. Convex Hull Calculation");
    println!("{}", "=".repeat(50));

    // Get all city points
    let city_points: Vec<Point> = cities.iter().map(|(p, _, _)| *p).collect();

    // Calculate convex hull
    if let Some(hull) = convex_hull(&city_points) {
        println!("Convex hull of all cities:");
        println!("  Exterior points: {}", hull.exterior().0.len() - 1);
        for coord in hull.exterior().0.iter().take(5) {
            println!("    ({:.4}, {:.4})", coord.x, coord.y);
        }
    }

    // ========================================
    // 6. Bounding Rectangle
    // ========================================
    println!("\n6. Bounding Rectangle");
    println!("{}", "=".repeat(50));

    if let Some(bbox) = bounding_rect_for_points(&city_points) {
        println!("Bounding rectangle of all cities:");
        println!("  Min: ({:.4}, {:.4})", bbox.min().x, bbox.min().y);
        println!("  Max: ({:.4}, {:.4})", bbox.max().x, bbox.max().y);
        println!("  Width:  {:.2}°", bbox.max().x - bbox.min().x);
        println!("  Height: {:.2}°", bbox.max().y - bbox.min().y);
    }

    // ========================================
    // 7. Advanced Radius Queries
    // ========================================
    println!("\n7. Advanced Radius Queries");
    println!("{}", "=".repeat(50));

    // Count cities within 1000km of NYC
    let count = db.count_within_radius("world_cities", &new_york, 1_000_000.0)?;
    println!("Cities within 1000km of NYC: {}", count);

    // Check if any cities exist within 100km
    let has_nearby = db.intersects_radius("world_cities", &new_york, 100_000.0)?;
    println!("Has cities within 100km of NYC: {}", has_nearby);

    // Query with radius
    let nearby = db.query_within_radius("world_cities", &new_york, 200_000.0, 10)?;
    println!("\nCities within 200km of NYC:");
    for (point, data, _distance) in &nearby {
        let city_info = String::from_utf8_lossy(data);
        let dist = distance_between(&new_york, point, DistanceMetric::Haversine);
        println!("  - {} ({:.2} km)", city_info, dist / 1000.0);
    }

    // ========================================
    // 8. Spatial Analytics
    // ========================================
    println!("\n8. Spatial Analytics");
    println!("{}", "=".repeat(50));

    // Find the two most distant cities (brute force)
    let mut max_distance = 0.0;
    let mut furthest_pair = ("", "");

    for (i, (p1, n1, _)) in cities.iter().enumerate() {
        for (p2, n2, _) in cities.iter().skip(i + 1) {
            let dist = distance_between(p1, p2, DistanceMetric::Geodesic);
            if dist > max_distance {
                max_distance = dist;
                furthest_pair = (n1, n2);
            }
        }
    }

    println!(
        "Most distant city pair: {} ↔ {}",
        furthest_pair.0, furthest_pair.1
    );
    println!("Distance: {:.2} km", max_distance / 1000.0);

    // Calculate average distance between all US cities
    let us_cities: Vec<_> = cities
        .iter()
        .filter(|(_, _, country)| *country == "USA")
        .collect();

    if us_cities.len() > 1 {
        let mut total_distance = 0.0;
        let mut count = 0;

        for (i, (p1, _, _)) in us_cities.iter().enumerate() {
            for (p2, _, _) in us_cities.iter().skip(i + 1) {
                total_distance += distance_between(p1, p2, DistanceMetric::Haversine);
                count += 1;
            }
        }

        let avg_distance = total_distance / count as f64;
        println!(
            "\nAverage distance between US cities: {:.2} km",
            avg_distance / 1000.0
        );
    }

    // ========================================
    // Summary
    // ========================================
    println!("\n{}", "=".repeat(50));
    println!("Summary:");
    println!("  - Demonstrated multiple distance metrics");
    println!("  - Performed K-nearest-neighbor searches");
    println!("  - Queried points within polygons");
    println!("  - Used bounding box operations");
    println!("  - Calculated convex hulls");
    println!("  - Performed spatial analytics");
    println!("\nAll spatial operations leverage the geo crate!");

    Ok(())
}

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. });

Examples found in repository

examples/advanced_spatial.rs (line 159)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("=== Advanced Spatial Operations Demo ===\n");

    // Create an in-memory database
    let mut db = Spatio::memory()?;

    // ========================================
    // 1. Distance Calculations
    // ========================================
    println!("1. Distance Calculations");
    println!("{}", "=".repeat(50));

    let new_york = Point::new(-74.0060, 40.7128);
    let los_angeles = Point::new(-118.2437, 34.0522);
    let london = Point::new(-0.1278, 51.5074);

    // Calculate distances using different metrics
    let dist_haversine = distance_between(&new_york, &los_angeles, DistanceMetric::Haversine);
    let dist_geodesic = distance_between(&new_york, &los_angeles, DistanceMetric::Geodesic);
    let dist_rhumb = distance_between(&new_york, &los_angeles, DistanceMetric::Rhumb);

    println!("NYC to LA:");
    println!("  Haversine:  {:.2} km", dist_haversine / 1000.0);
    println!("  Geodesic:   {:.2} km", dist_geodesic / 1000.0);
    println!("  Rhumb:      {:.2} km", dist_rhumb / 1000.0);

    // Using the database method
    let db_distance = db.distance_between(&new_york, &london, DistanceMetric::Haversine)?;
    println!("\nNYC to London: {:.2} km", db_distance / 1000.0);

    // ========================================
    // 2. K-Nearest-Neighbors (KNN)
    // ========================================
    println!("\n2. K-Nearest-Neighbors Query");
    println!("{}", "=".repeat(50));

    // Insert major cities
    let cities = vec![
        (Point::new(-74.0060, 40.7128), "New York", "USA"),
        (Point::new(-118.2437, 34.0522), "Los Angeles", "USA"),
        (Point::new(-87.6298, 41.8781), "Chicago", "USA"),
        (Point::new(-95.3698, 29.7604), "Houston", "USA"),
        (Point::new(-75.1652, 39.9526), "Philadelphia", "USA"),
        (Point::new(-122.4194, 37.7749), "San Francisco", "USA"),
        (Point::new(-0.1278, 51.5074), "London", "UK"),
        (Point::new(2.3522, 48.8566), "Paris", "France"),
        (Point::new(139.6917, 35.6895), "Tokyo", "Japan"),
    ];

    for (point, name, country) in &cities {
        let data = format!("{},{}", name, country);
        db.insert_point("world_cities", point, data.as_bytes(), None)?;
    }

    // Find 3 nearest cities to a query point (somewhere in New Jersey)
    let query_point = Point::new(-74.1719, 40.7357);
    let nearest = db.knn(
        "world_cities",
        &query_point,
        3,
        500_000.0, // Search within 500km
        DistanceMetric::Haversine,
    )?;

    println!("3 nearest cities to query point:");
    for (i, (_point, data, distance)) in nearest.iter().enumerate() {
        let city_info = String::from_utf8_lossy(data);
        println!(
            "  {}. {} ({:.2} km away)",
            i + 1,
            city_info,
            distance / 1000.0
        );
    }

    // ========================================
    // 3. Polygon Queries
    // ========================================
    println!("\n3. Polygon Queries");
    println!("{}", "=".repeat(50));

    // Define a polygon covering parts of the eastern US
    use geo::polygon;
    let east_coast_polygon = polygon![
        (x: -80.0, y: 35.0),  // South
        (x: -70.0, y: 35.0),  // Southeast
        (x: -70.0, y: 45.0),  // Northeast
        (x: -80.0, y: 45.0),  // Northwest
        (x: -80.0, y: 35.0),  // Close the polygon
    ];
    let east_coast_polygon: Polygon = east_coast_polygon.into();

    let cities_in_polygon = db.query_within_polygon("world_cities", &east_coast_polygon, 100)?;

    println!("Cities within East Coast polygon:");
    for (point, data) in &cities_in_polygon {
        let city_info = String::from_utf8_lossy(data);
        println!("  - {} at ({:.4}, {:.4})", city_info, point.x(), point.y());
    }

    // ========================================
    // 4. Bounding Box Operations
    // ========================================
    println!("\n4. Bounding Box Operations");
    println!("{}", "=".repeat(50));

    // Create a bounding box around the New York area
    let ny_bbox = bounding_box(-74.5, 40.5, -73.5, 41.0)?;
    println!("NY Area Bounding Box: {:?}", ny_bbox);

    // Find cities in bounding box
    let cities_in_bbox = db.find_within_bounds("world_cities", 40.5, -74.5, 41.0, -73.5, 100)?;
    println!("\nCities in NY area bounding box:");
    for (_point, data) in &cities_in_bbox {
        let city_info = String::from_utf8_lossy(data);
        println!("  - {}", city_info);
    }

    // ========================================
    // 5. Convex Hull
    // ========================================
    println!("\n5. Convex Hull Calculation");
    println!("{}", "=".repeat(50));

    // Get all city points
    let city_points: Vec<Point> = cities.iter().map(|(p, _, _)| *p).collect();

    // Calculate convex hull
    if let Some(hull) = convex_hull(&city_points) {
        println!("Convex hull of all cities:");
        println!("  Exterior points: {}", hull.exterior().0.len() - 1);
        for coord in hull.exterior().0.iter().take(5) {
            println!("    ({:.4}, {:.4})", coord.x, coord.y);
        }
    }

    // ========================================
    // 6. Bounding Rectangle
    // ========================================
    println!("\n6. Bounding Rectangle");
    println!("{}", "=".repeat(50));

    if let Some(bbox) = bounding_rect_for_points(&city_points) {
        println!("Bounding rectangle of all cities:");
        println!("  Min: ({:.4}, {:.4})", bbox.min().x, bbox.min().y);
        println!("  Max: ({:.4}, {:.4})", bbox.max().x, bbox.max().y);
        println!("  Width:  {:.2}°", bbox.max().x - bbox.min().x);
        println!("  Height: {:.2}°", bbox.max().y - bbox.min().y);
    }

    // ========================================
    // 7. Advanced Radius Queries
    // ========================================
    println!("\n7. Advanced Radius Queries");
    println!("{}", "=".repeat(50));

    // Count cities within 1000km of NYC
    let count = db.count_within_radius("world_cities", &new_york, 1_000_000.0)?;
    println!("Cities within 1000km of NYC: {}", count);

    // Check if any cities exist within 100km
    let has_nearby = db.intersects_radius("world_cities", &new_york, 100_000.0)?;
    println!("Has cities within 100km of NYC: {}", has_nearby);

    // Query with radius
    let nearby = db.query_within_radius("world_cities", &new_york, 200_000.0, 10)?;
    println!("\nCities within 200km of NYC:");
    for (point, data, _distance) in &nearby {
        let city_info = String::from_utf8_lossy(data);
        let dist = distance_between(&new_york, point, DistanceMetric::Haversine);
        println!("  - {} ({:.2} km)", city_info, dist / 1000.0);
    }

    // ========================================
    // 8. Spatial Analytics
    // ========================================
    println!("\n8. Spatial Analytics");
    println!("{}", "=".repeat(50));

    // Find the two most distant cities (brute force)
    let mut max_distance = 0.0;
    let mut furthest_pair = ("", "");

    for (i, (p1, n1, _)) in cities.iter().enumerate() {
        for (p2, n2, _) in cities.iter().skip(i + 1) {
            let dist = distance_between(p1, p2, DistanceMetric::Geodesic);
            if dist > max_distance {
                max_distance = dist;
                furthest_pair = (n1, n2);
            }
        }
    }

    println!(
        "Most distant city pair: {} ↔ {}",
        furthest_pair.0, furthest_pair.1
    );
    println!("Distance: {:.2} km", max_distance / 1000.0);

    // Calculate average distance between all US cities
    let us_cities: Vec<_> = cities
        .iter()
        .filter(|(_, _, country)| *country == "USA")
        .collect();

    if us_cities.len() > 1 {
        let mut total_distance = 0.0;
        let mut count = 0;

        for (i, (p1, _, _)) in us_cities.iter().enumerate() {
            for (p2, _, _) in us_cities.iter().skip(i + 1) {
                total_distance += distance_between(p1, p2, DistanceMetric::Haversine);
                count += 1;
            }
        }

        let avg_distance = total_distance / count as f64;
        println!(
            "\nAverage distance between US cities: {:.2} km",
            avg_distance / 1000.0
        );
    }

    // ========================================
    // Summary
    // ========================================
    println!("\n{}", "=".repeat(50));
    println!("Summary:");
    println!("  - Demonstrated multiple distance metrics");
    println!("  - Performed K-nearest-neighbor searches");
    println!("  - Queried points within polygons");
    println!("  - Used bounding box operations");
    println!("  - Calculated convex hulls");
    println!("  - Performed spatial analytics");
    println!("\nAll spatial operations leverage the geo crate!");

    Ok(())
}

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

where T: CoordNum + AbsDiffEq<Epsilon = T>,

fn abs_diff_eq( &self, other: &Rect<T>, epsilon: <Rect<T> as AbsDiffEq>::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() -> <Rect<T> as AbsDiffEq>::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> Area<T> for Rect<T>

where T: CoordNum,

Because a Rect has no winding order, the area will always be positive.

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T> BoundingRect<T> for Rect<T>

where T: CoordNum,

type Output = Rect<T>

fn bounding_rect(&self) -> <Rect<T> as BoundingRect<T>>::Output

Return the bounding rectangle of a geometry

impl<F> Buffer for Rect<F>

where F: BoolOpsNum + 'static,

type Scalar = F

fn buffer_with_style( &self, style: BufferStyle<<Rect<F> as Buffer>::Scalar>, ) -> MultiPolygon<<Rect<F> as Buffer>::Scalar>

Create a new geometry whose boundary is offset the specified distance from the input using the specific styling options where lines intersect (line joins) and end (end caps). For default (rounded) styling, see buffer.

fn buffer(&self, distance: Self::Scalar) -> MultiPolygon<Self::Scalar>

Create a new geometry whose boundary is offset the specified distance from the input.

impl<T> Centroid for Rect<T>

where T: GeoFloat,

fn centroid(&self) -> <Rect<T> as Centroid>::Output

The Centroid of a Rect is the mean of its Points

Examples

use geo::Centroid;
use geo::{Rect, point};

let rect = Rect::new(
  point!(x: 0.0f32, y: 0.0),
  point!(x: 1.0, y: 1.0),
);

assert_eq!(
    point!(x: 0.5, y: 0.5),
    rect.centroid(),
);

type Output = Point<T>

impl<T> ChamberlainDuquetteArea<T> for Rect<T>

where T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

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<F> ClosestPoint<F> for Rect<F>

where F: GeoFloat,

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<T> Contains<Coord<T>> for Rect<T>

where T: CoordNum,

fn contains(&self, coord: &Coord<T>) -> bool

impl<T> Contains<Geometry<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, geometry: &Geometry<T>) -> bool

impl<T> Contains<GeometryCollection<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &GeometryCollection<T>) -> bool

impl<T> Contains<Line<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &Line<T>) -> bool

impl<T> Contains<LineString<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<MultiLineString<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &MultiLineString<T>) -> bool

impl<T> Contains<MultiPoint<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPoint<T>) -> bool

impl<T> Contains<MultiPolygon<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> bool

impl<T> Contains<Point<T>> for Rect<T>

where T: CoordNum,

fn contains(&self, p: &Point<T>) -> bool

impl<T> Contains<Polygon<T>> for Rect<T>

where T: CoordFloat,

fn contains(&self, rhs: &Polygon<T>) -> bool

impl<T> Contains<Triangle<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains for Rect<T>

where T: CoordNum,

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

impl<T> CoordinatePosition for Rect<T>

where T: GeoNum,

type Scalar = T

fn calculate_coordinate_position( &self, coord: &Coord<T>, is_inside: &mut bool, boundary_count: &mut usize, )

fn coordinate_position(&self, coord: &Coord<Self::Scalar>) -> CoordPos

impl<T> CoordsIter for Rect<T>

where T: CoordNum,

fn coords_iter(&self) -> <Rect<T> as CoordsIter>::Iter<'_>

Iterates over the coordinates in CCW order

fn coords_count(&self) -> usize

Return the number of coordinates in the Rect.

Note: Although a Rect is represented by two coordinates, it is spatially represented by four, so this method returns 4.

type Iter<'a> = Chain<Chain<Chain<Once<Coord<T>>, Once<Coord<T>>>, Once<Coord<T>>>, Once<Coord<T>>> where T: 'a

type ExteriorIter<'a> = <Rect<T> as CoordsIter>::Iter<'a> where T: 'a

type Scalar = T

fn exterior_coords_iter(&self) -> <Rect<T> as CoordsIter>::ExteriorIter<'_>

Iterate over all exterior coordinates of a geometry.

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<F> Densifiable<F> for Rect<F>

where F: CoordFloat + FromPrimitive,

type Output = Polygon<F>

fn densify<MetricSpace>( &self, metric_space: &MetricSpace, max_segment_length: F, ) -> <Rect<F> as Densifiable<F>>::Output

where MetricSpace: Distance<F, Point<F>, Point<F>> + InterpolatePoint<F>,

impl<T> DensifyHaversine<T> for Rect<T>

where T: CoordFloat + FromPrimitive, Line<T>: HaversineLength<T>, LineString<T>: HaversineLength<T>,

type Output = Polygon<T>

👎Deprecated since 0.29.0: Please use the Haversine.densify(&line) via the Densify trait instead.

fn densify_haversine( &self, max_distance: T, ) -> <Rect<T> as DensifyHaversine<T>>::Output

👎Deprecated since 0.29.0: Please use the Haversine.densify(&line) via the Densify trait instead.

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

where T: CoordNum + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Rect<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> EuclideanDistance<T> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Geometry<T>> for Rect<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, geom: &Geometry<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, GeometryCollection<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &GeometryCollection<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &Line<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &LineString<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiLineString<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &MultiLineString<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPoint<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &MultiPoint<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &MultiPolygon<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &Point<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &Polygon<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Triangle<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

fn euclidean_distance(&self, other: &Triangle<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean.distance method from the Distance trait instead

Returns the distance between two geometries

impl GeodesicArea<f64> for Rect

fn geodesic_perimeter(&self) -> f64

Determine the perimeter of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_signed(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_unsigned(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter_area_signed(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

impl<C> HasDimensions for Rect<C>

where C: CoordNum,

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

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

where T: GeoFloat + FromPrimitive,

fn haversine_closest_point(&self, from: &Point<T>) -> Closest<T>

impl<T> InteriorPoint for Rect<T>

where T: GeoFloat,

type Output = Point<T>

fn interior_point(&self) -> <Rect<T> as InteriorPoint>::Output

Calculates a representative point inside the Geometry

impl<T> Intersects<Coord<T>> for Rect<T>

where T: CoordNum,

fn intersects(&self, rhs: &Coord<T>) -> bool

impl<T> Intersects<Geometry<T>> for Rect<T>

where Geometry<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<GeometryCollection<T>> for Rect<T>

where GeometryCollection<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &GeometryCollection<T>) -> bool

impl<T> Intersects<Line<T>> for Rect<T>

where T: GeoNum,

fn intersects(&self, rhs: &Line<T>) -> bool

impl<T> Intersects<LineString<T>> for Rect<T>

where LineString<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &LineString<T>) -> bool

impl<T> Intersects<MultiLineString<T>> for Rect<T>

where MultiLineString<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiLineString<T>) -> bool

impl<T> Intersects<MultiPoint<T>> for Rect<T>

where MultiPoint<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPoint<T>) -> bool

impl<T> Intersects<MultiPolygon<T>> for Rect<T>

where MultiPolygon<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPolygon<T>) -> bool

impl<T> Intersects<Point<T>> for Rect<T>

where Point<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &Point<T>) -> bool

impl<T> Intersects<Polygon<T>> for Rect<T>

where Polygon<T>: Intersects<Rect<T>>, T: CoordNum,

fn intersects(&self, rhs: &Polygon<T>) -> bool

impl<T> Intersects<Triangle<T>> for Rect<T>

where T: GeoNum,

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T> Intersects for Rect<T>

where T: CoordNum,

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

impl<'a, T> LinesIter<'a> for Rect<T>

where T: CoordNum + 'a,

type Scalar = T

type Iter = <[Line<<Rect<T> as LinesIter<'a>>::Scalar>; 4] as IntoIterator>::IntoIter

fn lines_iter(&'a self) -> <Rect<T> as LinesIter<'a>>::Iter

Iterate over all exterior and (if any) interior lines of a geometry.

impl<T, NT> MapCoords<T, NT> for Rect<T>

where T: CoordNum, NT: CoordNum,

type Output = Rect<NT>

fn map_coords( &self, func: impl Fn(Coord<T>) -> Coord<NT> + Copy, ) -> <Rect<T> as MapCoords<T, NT>>::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

fn try_map_coords<E>( &self, func: impl Fn(Coord<T>) -> Result<Coord<NT>, E>, ) -> Result<<Rect<T> as MapCoords<T, NT>>::Output, E>

Map a fallible function over all the coordinates in a geometry, returning a Result

impl<T> MapCoordsInPlace<T> for Rect<T>

where T: CoordNum,

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<T>)

Apply a function to all the coordinates in a geometric object, in place

fn try_map_coords_in_place<E>( &mut self, func: impl Fn(Coord<T>) -> Result<Coord<T>, E>, ) -> Result<(), E>

Map a fallible function over all the coordinates in a geometry, in place, returning a Result.

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<F> Relate<F> for Rect<F>

where F: GeoFloat,

fn geometry_graph(&self, arg_index: usize) -> GeometryGraph<'_, F>

Returns a noded topology graph for the geometry.

fn relate(&self, other: &impl Relate<F>) -> IntersectionMatrix

where Self: Sized,

impl<T> RelativeEq for Rect<T>

where T: CoordNum + RelativeEq<Epsilon = T>,

fn relative_eq( &self, other: &Rect<T>, epsilon: <Rect<T> as AbsDiffEq>::Epsilon, max_relative: <Rect<T> as AbsDiffEq>::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() -> <Rect<T> as AbsDiffEq>::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> RemoveRepeatedPoints<T> for Rect<T>

where T: CoordNum,

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

Create a new geometry with (consecutive) repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove (consecutive) repeated points inplace.

impl<T> Serialize for Rect<T>

where T: CoordNum + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

where T: CoordNum + UlpsEq<Epsilon = T>,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq( &self, other: &Rect<T>, epsilon: <Rect<T> as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<F> Validation for Rect<F>

where F: GeoFloat,

type Error = InvalidRect

fn visit_validation<T>( &self, handle_validation_error: Box<dyn FnMut(<Rect<F> as Validation>::Error) -> Result<(), T> + '_>, ) -> Result<(), T>

Visit the validation of the geometry.

fn is_valid(&self) -> bool

Check if the geometry is valid.

fn validation_errors(&self) -> Vec<Self::Error>

Return the reason(s) of invalidity of the geometry.

fn check_validation(&self) -> Result<(), Self::Error>

Return the first reason of invalidity of the geometry.

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,