Make FunctionError variants sound more error-y

bevyengine · Jun 29, 2024 · b8ed0a8 · b8ed0a8
1 parent 4088843
commit b8ed0a8
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 10 deletions.
diff --git a/crates/bevy_reflect/src/func/args/info.rs b/crates/bevy_reflect/src/func/args/info.rs
@@ -83,6 +83,8 @@ impl ArgInfo {
 }
 
 /// A representation of an argument.
+///
+/// This is primarily used for error reporting and debugging.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum ArgId {
     /// The index of the argument within its function.

diff --git a/crates/bevy_reflect/src/func/error.rs b/crates/bevy_reflect/src/func/error.rs
@@ -8,8 +8,8 @@ use thiserror::Error;
 pub enum FunctionError {
     /// An error occurred while converting an argument.
     #[error(transparent)]
-    Arg(#[from] ArgError),
+    ArgError(#[from] ArgError),
     /// The number of arguments provided does not match the expected number.
     #[error("expected {expected} arguments but received {received}")]
-    ArgCount { expected: usize, received: usize },
+    InvalidArgCount { expected: usize, received: usize },
 }
diff --git a/crates/bevy_reflect/src/func/into_function.rs b/crates/bevy_reflect/src/func/into_function.rs
@@ -137,7 +137,7 @@ macro_rules! impl_into_function {
 
                 $crate::func::DynamicFunction::new(move |args, _info| {
                     if args.len() != COUNT {
-                        return Err($crate::func::error::FunctionError::ArgCount {
+                        return Err($crate::func::error::FunctionError::InvalidArgCount {
                             expected: COUNT,
                             received: args.len(),
                         });
@@ -186,7 +186,7 @@ macro_rules! impl_into_function {
 
                 $crate::func::DynamicFunction::new(move |args, _info| {
                     if args.len() != COUNT {
-                        return Err($crate::func::error::FunctionError::ArgCount {
+                        return Err($crate::func::error::FunctionError::InvalidArgCount {
                             expected: COUNT,
                             received: args.len(),
                         });
@@ -237,7 +237,7 @@ macro_rules! impl_into_function {
 
                 $crate::func::DynamicFunction::new(move |args, _info| {
                     if args.len() != COUNT {
-                        return Err($crate::func::error::FunctionError::ArgCount {
+                        return Err($crate::func::error::FunctionError::InvalidArgCount {
                             expected: COUNT,
                             received: args.len(),
                         });
@@ -288,7 +288,7 @@ macro_rules! impl_into_function {
 
                 $crate::func::DynamicFunction::new(move |args, _info| {
                     if args.len() != COUNT {
-                        return Err($crate::func::error::FunctionError::ArgCount {
+                        return Err($crate::func::error::FunctionError::InvalidArgCount {
                             expected: COUNT,
                             received: args.len(),
                         });

diff --git a/crates/bevy_reflect/src/func/mod.rs b/crates/bevy_reflect/src/func/mod.rs
@@ -166,7 +166,7 @@ mod tests {
         let result = func.call(args);
         assert_eq!(
             result.unwrap_err(),
-            FunctionError::ArgCount {
+            FunctionError::InvalidArgCount {
                 expected: 1,
                 received: 0
             }
@@ -182,7 +182,7 @@ mod tests {
         let result = func.call(args);
         assert_eq!(
             result.unwrap_err(),
-            FunctionError::ArgCount {
+            FunctionError::InvalidArgCount {
                 expected: 0,
                 received: 1
             }
@@ -198,7 +198,7 @@ mod tests {
         let result = func.call(args);
         assert_eq!(
             result.unwrap_err(),
-            FunctionError::Arg(ArgError::UnexpectedType {
+            FunctionError::ArgError(ArgError::UnexpectedType {
                 id: ArgId::Index(0),
                 expected: Cow::Borrowed(i32::type_path()),
                 received: Cow::Borrowed(u32::type_path())
@@ -215,7 +215,7 @@ mod tests {
         let result = func.call(args);
         assert_eq!(
             result.unwrap_err(),
-            FunctionError::Arg(ArgError::InvalidOwnership {
+            FunctionError::ArgError(ArgError::InvalidOwnership {
                 id: ArgId::Index(0),
                 expected: Ownership::Ref,
                 received: Ownership::Owned