Fixed issue with border panicking

Made Border fields public
Made vec2 method const
Fixed issues with doctests, and made them run or compile

Author: EmeraldPandaTurtle

Cargo.toml

@@ -7,10 +7,6 @@ readme = "README.md"
 repository = "https://github.com/TheEmeraldBee/ascii-forge"
 license = "MIT OR Apache-2.0"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-[lib]
-doctest = false
-
 [dependencies]
 compact_str = "0.9.0"
 crossterm = "0.29.0"

src/math.rs

@@ -59,6 +59,6 @@ impl<V: Into<Vec2>> SubAssign<V> for Vec2 {
 }
 
 /// Creates a Vec2 from the given inputs.
-pub fn vec2(x: u16, y: u16) -> Vec2 {
+pub const fn vec2(x: u16, y: u16) -> Vec2 {
     Vec2 { x, y }
 }

src/renderer/buffer.rs

@@ -6,18 +6,15 @@ A screen buffer that can be rendered to, has a size
 This is the backbone of ascii-forge
 
 `Example`
-```rust, no_run
-use ascii_forge::prelude::*;
-
+```rust
+# use ascii_forge::prelude::*;
+# fn main() {
 // A 30x30 buffer window
-let mut buffer = Buffer::new(30, 30);
+let mut buffer = Buffer::new((30, 30));
 
 // Render Hello World to the top left of the buffer
-render!(
-    buffer, {
-        (0, 0) => "Hello World!"
-    }
-);
+render!(buffer, (0, 0) => [ "Hello World!" ]);
+# }
 ```
 
 */

src/renderer/render.rs

@@ -10,17 +10,20 @@ use crate::prelude::*;
 /**
 `Example`
 ```rust
-use crate::prelude::*;
-
-// Create a window
-let window = Window::init()?;
+# use ascii_forge::prelude::*;
+# fn main() -> std::io::Result<()> {
+// Create a buffer
+let mut buffer = Buffer::new((32, 32));
 
 // Render This works! and Another Element! To the window's buffer
 render!(
-    window,
-        (16, 16) => [ "This works!" ]
+    buffer,
+        (16, 16) => [ "This works!" ],
         (0, 0) => [ "Another Element!" ]
 );
+
+# Ok(())
+# }
 ```
 */
 #[macro_export]

src/widgets/border.rs

@@ -2,22 +2,21 @@ use crate::prelude::*;
 
 /// A basic border type.
 /// Rendering this will put the next content inside of the function
+/// Borders will skip rendering if their size is under a 3x3
 pub struct Border {
-    width: u16,
-    height: u16,
-    horizontal: &'static str,
-    vertical: &'static str,
-    top_left: &'static str,
-    top_right: &'static str,
-    bottom_left: &'static str,
-    bottom_right: &'static str,
+    pub size: Vec2,
+    pub horizontal: &'static str,
+    pub vertical: &'static str,
+    pub top_left: &'static str,
+    pub top_right: &'static str,
+    pub bottom_left: &'static str,
+    pub bottom_right: &'static str,
 }
 
 impl Border {
     pub const fn square(width: u16, height: u16) -> Border {
         Border {
-            width,
-            height,
+            size: vec2(width, height),
             horizontal: "─",
             vertical: "│",
             top_right: "┐",
@@ -27,22 +26,29 @@ impl Border {
         }
     }
 }
+
 impl Render for Border {
     fn render(&self, loc: Vec2, buffer: &mut Buffer) -> Vec2 {
-        for y in (loc.y + 1)..(loc.y + self.height - 1) {
+        if self.size.x < 3 || self.size.y < 3 {
+            return loc;
+        }
+        for y in (loc.y + 1)..(loc.y + self.size.y.saturating_sub(1)) {
             buffer.set(vec2(loc.x, y), self.vertical);
-            buffer.set(vec2(loc.x + self.width - 1, y), self.vertical);
+            buffer.set(
+                vec2(loc.x + self.size.x.saturating_sub(1), y),
+                self.vertical,
+            );
         }
 
         let _ = render!(buffer,
-            loc => [self.top_left, self.horizontal.repeat(self.width as usize - 2), self.top_right],
-            vec2(loc.x, loc.y + self.height - 1) => [self.bottom_left, self.horizontal.repeat(self.width as usize - 2), self.bottom_right]
+            loc => [self.top_left, self.horizontal.repeat(self.size.x.saturating_sub(2) as usize), self.top_right],
+            vec2(loc.x, loc.y + self.size.y.saturating_sub(1)) => [self.bottom_left, self.horizontal.repeat(self.size.x.saturating_sub(2) as usize), self.bottom_right]
         );
 
         vec2(loc.x + 1, loc.y + 1)
     }
     fn size(&self) -> Vec2 {
-        vec2(self.width, self.height)
+        self.size
     }
 }
 
@@ -55,6 +61,13 @@ mod test {
         window::{Buffer, Render},
     };
 
+    #[test]
+    fn render_small() {
+        let border = Border::square(0, 0);
+        // Ensure no panics
+        let _ = Buffer::sized_element(border);
+    }
+
     #[test]
     fn check_size() {
         let border = Border::square(16, 16);

src/window.rs

@@ -30,17 +30,16 @@ impl AsMut<Buffer> for Window {
 /// Represents the terminal window, allowing it to be used similar to a buffer,
 /// but has extra event handling.
 /**
-```rust,
-use ascii_forge::prelude::*;
+```rust, no_run
+# use ascii_forge::prelude::*;
 
+# fn main() -> std::io::Result<()> {
 let mut window = Window::init()?;
 
-render!(
-    window,
-    [
-        (10, 10) => "Element Here!"
-    ]
-)
+render!(window, (10, 10) => [ "Element Here!" ]);
+
+# Ok(())
+# }
 ```
 */
 pub struct Window {
@@ -375,7 +374,12 @@ impl Window {
 /**
 Example
 ```rust, no_run
+# use ascii_forge::prelude::*;
+# fn main() -> std::io::Result<()> {
+# let mut window = Window::init()?;
 event!(window, Event::Key(e) => e.code == KeyCode::Char('q'));
+# Ok(())
+# }
 ```
 */
 #[macro_export]