efda7f3f9c
Takes the first two commits from #15375 and adds suggestions from this comment: https://github.com/bevyengine/bevy/pull/15375#issuecomment-2366968300 See #15375 for more reasoning/motivation. ## Rebasing (rerunning) ```rust git switch simpler-lint-fixes git reset --hard main cargo fmt --all -- --unstable-features --config normalize_comments=true,imports_granularity=Crate cargo fmt --all git add --update git commit --message "rustfmt" cargo clippy --workspace --all-targets --all-features --fix cargo fmt --all -- --unstable-features --config normalize_comments=true,imports_granularity=Crate cargo fmt --all git add --update git commit --message "clippy" git cherry-pick e6c0b94f6795222310fb812fa5c4512661fc7887 ```
42 lines
1.6 KiB
Rust
42 lines
1.6 KiB
Rust
use crate::func::{args::ArgError, Return};
|
|
use alloc::borrow::Cow;
|
|
use thiserror::Error;
|
|
|
|
/// An error that occurs when calling a [`DynamicFunction`] or [`DynamicFunctionMut`].
|
|
///
|
|
/// [`DynamicFunction`]: crate::func::DynamicFunction
|
|
/// [`DynamicFunctionMut`]: crate::func::DynamicFunctionMut
|
|
#[derive(Debug, Error, PartialEq)]
|
|
pub enum FunctionError {
|
|
/// An error occurred while converting an argument.
|
|
#[error(transparent)]
|
|
ArgError(#[from] ArgError),
|
|
/// The number of arguments provided does not match the expected number.
|
|
#[error("expected {expected} arguments but received {received}")]
|
|
ArgCountMismatch { expected: usize, received: usize },
|
|
}
|
|
|
|
/// The result of calling a [`DynamicFunction`] or [`DynamicFunctionMut`].
|
|
///
|
|
/// Returns `Ok(value)` if the function was called successfully,
|
|
/// where `value` is the [`Return`] value of the function.
|
|
///
|
|
/// [`DynamicFunction`]: crate::func::DynamicFunction
|
|
/// [`DynamicFunctionMut`]: crate::func::DynamicFunctionMut
|
|
pub type FunctionResult<'a> = Result<Return<'a>, FunctionError>;
|
|
|
|
/// An error that occurs when registering a function into a [`FunctionRegistry`].
|
|
///
|
|
/// [`FunctionRegistry`]: crate::func::FunctionRegistry
|
|
#[derive(Debug, Error, PartialEq)]
|
|
pub enum FunctionRegistrationError {
|
|
/// A function with the given name has already been registered.
|
|
///
|
|
/// Contains the duplicate function name.
|
|
#[error("a function has already been registered with name {0:?}")]
|
|
DuplicateName(Cow<'static, str>),
|
|
/// The function is missing a name by which it can be registered.
|
|
#[error("function name is missing")]
|
|
MissingName,
|
|
}
|