Cleanup (#723)

* Fix code block end

* Clean up some clippy warnings

* Fix a few typos

* Add note about defmt and MSRV

README.md

@@ -128,7 +128,8 @@ calculation.
 
 * `defmt` - provide implementations of `defmt::Format` for all types where possible. [`defmt`]
   is a library for logging that moves as much work as possible over to a separate logging
-  machine, making it especially suited to low-resource MCUs.
+  machine, making it especially suited to low-resource MCUs. Note that `defmt` might not work with
+  older versions of rustc that are otherwise supported by embedded-graphics.
 
 ## Migrating from older versions
 

core/README.md

@@ -19,7 +19,7 @@ Applications should instead depend on [embedded-graphics] itself.
 
 Like any other crate, embedded-graphics-core will change over time, however it will change at a
 much slower rate than embedded-graphics itself, and will likely release fewer breaking changes.
-This will provide more stability and compatability for the weider embedded-graphics ecosystem,
+This will provide more stability and compatibility for the wider embedded-graphics ecosystem,
 whilst allowing non-core features of embedded-graphics to evolve at a faster pace. The same
 version of embedded-graphics-core may be used for multiple major versions of embedded-graphics.
 
@@ -62,7 +62,8 @@ a spritemap.
 
 ## Features
 
- - `defmt` - implements `defmt::Format` for all types where this is possible.
+ - `defmt` - implements `defmt::Format` for all types where this is possible. Note that `defmt`
+   might not work with older versions of rustc that are otherwise supported by embedded-graphics-core.
 
 [embedded-graphics]: https://docs.rs/embedded-graphics
 [`Rgb888`]: pixelcolor::Rgb888

core/src/geometry/size.rs

@@ -184,8 +184,8 @@ impl Size {
 
     /// Creates a size from two corner points of a bounding box.
     pub(crate) const fn from_bounding_box(corner_1: Point, corner_2: Point) -> Self {
-        let width = (corner_1.x - corner_2.x).abs() as u32 + 1;
-        let height = (corner_1.y - corner_2.y).abs() as u32 + 1;
+        let width = (corner_1.x - corner_2.x).unsigned_abs() + 1;
+        let height = (corner_1.y - corner_2.y).unsigned_abs() + 1;
 
         Self { width, height }
     }

core/src/lib.rs

@@ -7,7 +7,7 @@
 //!
 //! Like any other crate, embedded-graphics-core will change over time, however it will change at a
 //! much slower rate than embedded-graphics itself, and will likely release fewer breaking changes.
-//! This will provide more stability and compatability for the weider embedded-graphics ecosystem,
+//! This will provide more stability and compatibility for the wider embedded-graphics ecosystem,
 //! whilst allowing non-core features of embedded-graphics to evolve at a faster pace. The same
 //! version of embedded-graphics-core may be used for multiple major versions of embedded-graphics.
 //!
@@ -52,7 +52,8 @@
 //!
 //! # Features
 //!
-//!  - `defmt` - implements `defmt::Format` for all types where this is possible.
+//!  - `defmt` - implements `defmt::Format` for all types where this is possible. Note that `defmt`
+//!    might not work with older versions of rustc that are otherwise supported by embedded-graphics-core.
 //!
 //! [embedded-graphics]: https://docs.rs/embedded-graphics
 //! [`Pixel`]: drawable::Pixel

core/src/primitives/rectangle/mod.rs

@@ -268,7 +268,7 @@ impl Rectangle {
     /// );
     /// ```
     pub fn resized(&self, size: Size, anchor_point: AnchorPoint) -> Self {
-        let mut resized = self.clone();
+        let mut resized = *self;
         resized.resize_width_mut(size.width, anchor_point.x());
         resized.resize_height_mut(size.height, anchor_point.y());
 
@@ -295,7 +295,7 @@ impl Rectangle {
     /// );
     /// ```
     pub fn resized_width(&self, width: u32, anchor_x: AnchorX) -> Self {
-        let mut resized = self.clone();
+        let mut resized = *self;
         resized.resize_width_mut(width, anchor_x);
 
         resized
@@ -321,7 +321,7 @@ impl Rectangle {
     /// );
     /// ```
     pub fn resized_height(&self, height: u32, anchor_y: AnchorY) -> Self {
-        let mut resized = self.clone();
+        let mut resized = *self;
         resized.resize_height_mut(height, anchor_y);
 
         resized

src/framebuffer.rs

@@ -59,6 +59,7 @@ pub struct Framebuffer<C, R, BO, const WIDTH: usize, const HEIGHT: usize, const
     color_type: PhantomData<C>,
     raw_type: PhantomData<R>,
     byte_order: PhantomData<BO>,
+    n_assert: (),
 }
 
 impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize>
@@ -70,23 +71,19 @@ where
 
     /// Static assertion that N is correct.
     // MSRV: remove N when constant generic expressions are stabilized
-    const CHECK_N: () = if N < Self::BUFFER_SIZE {
-        panic!("Invalid N: see Framebuffer documentation for more information");
-    };
+    const CHECK_N: () = assert!(
+        N >= Self::BUFFER_SIZE,
+        "Invalid N: see Framebuffer documentation for more information"
+    );
 
     /// Creates a new framebuffer.
     pub const fn new() -> Self {
-        #[allow(path_statements)]
-        {
-            // Make sure CHECK_N isn't optimized out.
-            Self::CHECK_N;
-        }
-
         Self {
             data: [0; N],
             color_type: PhantomData,
             raw_type: PhantomData,
             byte_order: PhantomData,
+            n_assert: Self::CHECK_N,
         }
     }
 

src/lib.rs

@@ -116,7 +116,8 @@
 //!
 //! * `defmt` - provide implementations of `defmt::Format` for all types where possible. [`defmt`]
 //!   is a library for logging that moves as much work as possible over to a separate logging
-//!   machine, making it especially suited to low-resource MCUs.
+//!   machine, making it especially suited to low-resource MCUs. Note that `defmt` might not work with
+//!   older versions of rustc that are otherwise supported by embedded-graphics.
 //!
 //! # Migrating from older versions
 //!

src/mock_display/mod.rs

@@ -424,7 +424,7 @@ where
         mirrored
     }
 
-    /// Maps a `MockDisplay<C>' to a `MockDisplay<CT>` by applying a function
+    /// Maps a `MockDisplay<C>` to a `MockDisplay<CT>` by applying a function
     /// to each pixel.
     ///
     /// # Examples

src/mono_font/draw_target.rs

@@ -65,7 +65,7 @@ impl<T: DrawTarget> DrawTarget for MonoFontDrawTarget<'_, T, Background<T::Color
         self.parent.draw_iter(
             colors
                 .into_iter()
-                .into_pixels(&area)
+                .into_pixels(area)
                 .filter(|Pixel(_, color)| color.is_off())
                 .map(|Pixel(pos, _)| Pixel(pos, foreground_color)),
         )

src/primitives/common/scanline.rs

@@ -33,12 +33,10 @@ impl Scanline {
     fn extend(&mut self, x: i32) {
         if self.is_empty() {
             self.x = x..x + 1;
-        } else {
-            if x < self.x.start {
-                self.x.start = x;
-            } else if x >= self.x.end {
-                self.x.end = x + 1;
-            }
+        } else if x < self.x.start {
+            self.x.start = x;
+        } else if x >= self.x.end {
+            self.x.end = x + 1;
         }
     }
 

src/primitives/line/mod.rs

@@ -120,6 +120,7 @@ impl Line {
         let mut right = (self.start, ParallelLineType::Normal);
 
         match stroke_offset {
+            #[allow(clippy::while_let_loop)]
             StrokeOffset::None => loop {
                 if let Some((bresenham, reduce)) = it.next() {
                     right = (bresenham.point, reduce);

src/primitives/line/styled.rs

@@ -26,7 +26,7 @@ impl<C: PixelColor> StyledPixelsIterator<C> {
 
         Self {
             stroke_color,
-            line_iter: ThickPoints::new(&primitive, stroke_width),
+            line_iter: ThickPoints::new(primitive, stroke_width),
         }
     }
 }

src/primitives/triangle/scanline_intersections.rs

@@ -194,6 +194,7 @@ impl Iterator for ScanlineIntersections {
     type Item = (Scanline, PointType);
 
     fn next(&mut self) -> Option<Self::Item> {
+        #[allow(clippy::manual_map)]
         if let Some(internal) = self.lines.internal.try_take() {
             Some((internal, self.lines.internal_type))
         } else if let Some(first) = self.lines.first.try_take() {

src/primitives/triangle/styled.rs

@@ -25,7 +25,7 @@ pub struct StyledPixelsIterator<C> {
 impl<C: PixelColor> StyledPixelsIterator<C> {
     pub(in crate::primitives) fn new(primitive: &Triangle, style: &PrimitiveStyle<C>) -> Self {
         let mut lines_iter = ScanlineIterator::new(
-            &primitive,
+            primitive,
             style.stroke_width,
             StrokeOffset::from(style.stroke_alignment),
             style.fill_color.is_some(),
@@ -97,7 +97,7 @@ impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Triangle {
         }
 
         for (line, kind) in ScanlineIterator::new(
-            &self,
+            self,
             style.stroke_width,
             StrokeOffset::from(style.stroke_alignment),
             style.fill_color.is_some(),