derive common traits, improve documentation

Author: CleanCut

CHANGELOG.md

@@ -1,9 +1,15 @@
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
 
+### Improved
+
+- Implemented all the [common traits](https://rust-lang.github.io/api-guidelines/interoperability.html) on public `struct`s and `enum`s that made sense.
+- Added documentation for a few structs, enums, and methods that were missing it.
+
 ### Fixed
 
 - The `collider` example once again properly regenerates the visualization for circle colliders whenever they are created or altered.
+- Changed visibility of internal Bevy plugins from `pub` to `pub(crate)`. Technically this is a breaking change, but these wouldn't have been usable to anyone anyway so I'm ignoring the technicality.
 
 ## [5.0.0] - 2022-03-12
 

src/keyboard.rs

@@ -4,7 +4,7 @@ use bevy::{prelude::*, utils::HashMap};
 // Re-export some Bevy types to use
 pub use bevy::input::keyboard::{KeyCode, KeyboardInput};
 
-pub struct KeyboardPlugin;
+pub(crate) struct KeyboardPlugin;
 
 impl Plugin for KeyboardPlugin {
     fn build(&self, app: &mut bevy::prelude::App) {

src/mouse.rs

@@ -10,7 +10,7 @@ pub use bevy::{
     window::CursorMoved,
 };
 
-pub struct MousePlugin;
+pub(crate) struct MousePlugin;
 
 impl Plugin for MousePlugin {
     fn build(&self, app: &mut bevy::prelude::App) {
@@ -41,7 +41,7 @@ pub struct MouseState {
 /// the mouse wheel as if scrolling in a direction were equivalent to clicking a mouse button, you
 /// probably want to use
 /// [`Engine::mouse_wheel_events`](crate::prelude::Engine::mouse_wheel_events) instead.
-#[derive(Clone, Copy, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default, PartialEq)]
 pub struct MouseWheelState {
     /// The y component of the mouse wheel movement. This is the "normal" scrolling direction of a
     /// typical mouse wheel. This will be either `-1.0`, `0.0`, or `1.0`. For fine-grained

src/physics.rs

@@ -7,7 +7,7 @@ use std::{
     hash::Hash,
 };
 
-pub struct PhysicsPlugin;
+pub(crate) struct PhysicsPlugin;
 
 impl Plugin for PhysicsPlugin {
     fn build(&self, app: &mut App) {
@@ -20,13 +20,14 @@ impl Plugin for PhysicsPlugin {
 /// [Sprite]s which:
 /// - have colliders (you can use the `collider` example to create your own colliders)
 /// - have their `collision` flags set to `true`.
-#[derive(Debug, Clone)]
+#[derive(Clone, Debug, PartialEq)]
 pub struct CollisionEvent {
     pub state: CollisionState,
     pub pair: CollisionPair,
 }
 
-#[derive(Debug, Clone, Copy)]
+/// Indicates whether a [`CollisionEvent`] is at the beginning or ending of a collision.
+#[derive(Clone, Copy, Debug, PartialEq)]
 pub enum CollisionState {
     Begin,
     End,
@@ -47,22 +48,27 @@ impl CollisionState {
     }
 }
 
+/// Contains the labels of the two sprites involved in the collision. As the labels are unordered,
+/// several convenience methods are provided for searching the values.
 #[derive(Debug, Default, Eq, Clone)]
 pub struct CollisionPair(pub String, pub String);
 
 impl CollisionPair {
-    pub fn either_contains<T: Into<String>>(&self, label: T) -> bool {
-        let label = label.into();
-        (self.0 == label) || (self.1 == label)
+    /// Whether either of the labels contains the text.
+    pub fn either_contains<T: Into<String>>(&self, text: T) -> bool {
+        let text = text.into();
+        (self.0 == text) || (self.1 == text)
     }
-    pub fn either_starts_with<T: Into<String>>(&self, label: T) -> bool {
-        let label = label.into();
-        self.0.starts_with(&label) || self.1.starts_with(&label)
+    /// Whether either of the labels starts with the text.
+    pub fn either_starts_with<T: Into<String>>(&self, text: T) -> bool {
+        let text = text.into();
+        self.0.starts_with(&text) || self.1.starts_with(&text)
     }
-    pub fn one_starts_with<T: Into<String>>(&self, label: T) -> bool {
-        let label = label.into();
-        let a_matches = self.0.starts_with(&label);
-        let b_matches = self.1.starts_with(&label);
+    /// Whether exactly one of the labels starts with the text.
+    pub fn one_starts_with<T: Into<String>>(&self, text: T) -> bool {
+        let text = text.into();
+        let a_matches = self.0.starts_with(&text);
+        let b_matches = self.1.starts_with(&text);
         (a_matches && !b_matches) || (!a_matches && b_matches)
     }
 }

src/sprite.rs

@@ -4,7 +4,7 @@ use crate::physics::Collider;
 
 /// A [`Sprite`] is the basic abstraction for something that can be seen and interacted with.
 /// Players, obstacles, etc. are all sprites.
-#[derive(Clone, Component, Debug)]
+#[derive(Clone, Component, Debug, PartialEq)]
 pub struct Sprite {
     /// READONLY: A way to identify a sprite.
     pub label: String,

src/text.rs

@@ -7,7 +7,7 @@ pub const TEXT_DEFAULT_LAYER: f32 = 900.0;
 pub const TEXT_DEFAULT_FONT_SIZE: f32 = 30.0;
 
 /// A [`Text`] is a bit of text that exists on the screen.
-#[derive(Clone, Component, Debug)]
+#[derive(Clone, Component, Debug, PartialEq)]
 pub struct Text {
     /// READONLY: A label to identify the text. This is not the text that is displayed! This is the
     /// label you use to retrieve and modify your text from the