Auto merge of #463 - nical:intersect-non-empty, r=nical

(breaking change) Make intersection return Option<Self>

Replaces #462

As I go through the webrender update I realize that returning `Option<NonEmpty<Self>>` adds way more friction than I anticipated. Pretty much all call sites have to be worked around in different ways. #462 helps for at least a good half of the call sites, but there are many other patterns, and I am not running into cases where NonEmpty is adding value, because we end up having to deal with storing something when the intersection is empty (the way webrender's code is shaped).

I'm very woriied that `intersection` is just going to be a pain to use by default, with NonEmpty providing more friction than value, so considering 0.21 is just out, I would rather make a early 0.22 now before a significant part of downstream users have had time to update to 0.21, and get rid of the thorn before we are stuck with it.

Note that for cases where `Option<NonEmpty<Box2D>>` would have been desirable, we can still write `b.intersection_unchecked(b2).to_non_empty(), which is not too inconvenient even if not the default.

Author: bors-servo

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "euclid"
-version = "0.21.0"
+version = "0.22.0"
 authors = ["The Servo Project Developers"]
 edition = "2018"
 description = "Geometry primitives"

src/box2d.rs

@@ -9,7 +9,6 @@
 
 use super::UnknownUnit;
 use crate::approxord::{max, min};
-use crate::nonempty::NonEmpty;
 use crate::num::*;
 use crate::point::{point2, Point2D};
 use crate::rect::Rect;
@@ -162,18 +161,24 @@ where
     T: Copy + PartialOrd,
 {
     #[inline]
-    pub fn to_non_empty(&self) -> Option<NonEmpty<Self>> {
+    pub fn to_non_empty(&self) -> Option<Self> {
         if self.is_empty() {
             return None;
         }
 
-        Some(NonEmpty(*self))
+        Some(*self)
     }
 
     /// Computes the intersection of two boxes, returning `None` if the boxes do not intersect.
     #[inline]
-    pub fn intersection(&self, other: &Self) -> Option<NonEmpty<Self>> {
-        self.intersection_unchecked(other).to_non_empty()
+    pub fn intersection(&self, other: &Self) -> Option<Self> {
+        let b = self.intersection_unchecked(other);
+
+        if b.is_empty() {
+            return None;
+        }
+
+        Some(b)
     }
 
     /// Computes the intersection of two boxes without check whether they do intersect.

src/box3d.rs

@@ -9,7 +9,6 @@
 
 use super::UnknownUnit;
 use crate::approxord::{max, min};
-use crate::nonempty::NonEmpty;
 use crate::num::*;
 use crate::point::{point3, Point3D};
 use crate::scale::Scale;
@@ -140,17 +139,23 @@ where
     T: Copy + PartialOrd,
 {
     #[inline]
-    pub fn to_non_empty(&self) -> Option<NonEmpty<Self>> {
+    pub fn to_non_empty(&self) -> Option<Self> {
         if self.is_empty() {
             return None;
         }
 
-        Some(NonEmpty(*self))
+        Some(*self)
     }
 
     #[inline]
-    pub fn intersection(&self, other: &Self) -> Option<NonEmpty<Self>> {
-        self.intersection_unchecked(other).to_non_empty()
+    pub fn intersection(&self, other: &Self) -> Option<Self> {
+        let b = self.intersection_unchecked(other);
+
+        if b.is_empty() {
+            return None;
+        }
+
+        Some(b)
     }
 
     pub fn intersection_unchecked(&self, other: &Self) -> Self {

src/lib.rs

@@ -44,7 +44,6 @@ pub use crate::angle::Angle;
 pub use crate::box2d::Box2D;
 pub use crate::homogen::HomogeneousVector;
 pub use crate::length::Length;
-pub use crate::nonempty::NonEmpty;
 pub use crate::point::{point2, point3, Point2D, Point3D};
 pub use crate::scale::Scale;
 pub use crate::transform2d::Transform2D;
@@ -71,7 +70,6 @@ mod box2d;
 mod box3d;
 mod homogen;
 mod length;
-mod nonempty;
 pub mod num;
 mod point;
 mod rect;

src/nonempty.rs

@@ -9,7 +9,6 @@
 
 use super::UnknownUnit;
 use crate::box2d::Box2D;
-use crate::nonempty::NonEmpty;
 use crate::num::*;
 use crate::point::Point2D;
 use crate::scale::Scale;
@@ -215,13 +214,14 @@ where
     T: Copy + PartialOrd + Add<T, Output = T> + Sub<T, Output = T>,
 {
     #[inline]
-    pub fn intersection(&self, other: &Self) -> Option<NonEmpty<Self>> {
+    pub fn intersection(&self, other: &Self) -> Option<Self> {
         let box2d = self.to_box2d().intersection_unchecked(&other.to_box2d());
+
         if box2d.is_empty() {
             return None;
         }
 
-        Some(NonEmpty(box2d.to_rect()))
+        Some(box2d.to_rect())
     }
 }
 
@@ -393,12 +393,12 @@ impl<T: Copy + Zero + PartialOrd, U> Rect<T, U> {
 
 impl<T: Copy + Zero + PartialOrd, U> Rect<T, U> {
     #[inline]
-    pub fn to_non_empty(&self) -> Option<NonEmpty<Self>> {
+    pub fn to_non_empty(&self) -> Option<Self> {
         if self.is_empty() {
             return None;
         }
 
-        Some(NonEmpty(*self))
+        Some(*self)
     }
 }