Skip to content

bevy_reflect: Update internal docs regarding anonymous function type names #14666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alice-i-cecile merged 1 commit into from
Aug 8, 2024
Merged

bevy_reflect: Update internal docs regarding anonymous function type names #14666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 45 additions & 4 deletions crates/bevy_reflect/src/func/info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,9 @@ all_tuples!(impl_typed_function, 0, 15, Arg, arg);
///
/// | Category | `type_name` | `FunctionInfo::name` |
/// | ------------------ | ----------------------- | ----------------------- |
/// | Named function | `foo::bar::baz` | `Some("foo::bar::baz")` |
/// | Named function | `foo::bar::baz` | `Some("foo::bar::baz")` |
/// | Closure | `foo::bar::{{closure}}` | `None` |
/// | Anonymous function | `fn() -> String` | `None` |
/// | Anonymous function | `foo::bar::{{closure}}` | `None` |
/// | Function pointer | `fn() -> String` | `None` |
///
/// [`type_name`]: std::any::type_name
Expand All @@ -368,6 +368,12 @@ mod tests {
a + b
}

// Sanity check:
assert_eq!(
std::any::type_name_of_val(&add),
"bevy_reflect::func::info::tests::should_create_function_info::add"
);

let info = add.get_function_info();
assert_eq!(
info.name().unwrap(),
Expand All @@ -379,9 +385,36 @@ mod tests {
assert_eq!(info.return_info().type_path(), "i32");
}

#[test]
fn should_create_function_pointer_info() {
fn add(a: i32, b: i32) -> i32 {
a + b
}

let add = add as fn(i32, i32) -> i32;

// Sanity check:
assert_eq!(std::any::type_name_of_val(&add), "fn(i32, i32) -> i32");

let info = add.get_function_info();
assert!(info.name().is_none());
assert_eq!(info.arg_count(), 2);
assert_eq!(info.args()[0].type_path(), "i32");
assert_eq!(info.args()[1].type_path(), "i32");
assert_eq!(info.return_info().type_path(), "i32");
}

#[test]
fn should_create_anonymous_function_info() {
let info = (|a: i32, b: i32| a + b).get_function_info();
let add = |a: i32, b: i32| a + b;

// Sanity check:
assert_eq!(
std::any::type_name_of_val(&add),
"bevy_reflect::func::info::tests::should_create_anonymous_function_info::{{closure}}"
);

let info = add.get_function_info();
assert!(info.name().is_none());
assert_eq!(info.arg_count(), 2);
assert_eq!(info.args()[0].type_path(), "i32");
Expand All @@ -392,7 +425,15 @@ mod tests {
#[test]
fn should_create_closure_info() {
let mut total = 0;
let info = (|a: i32, b: i32| total = a + b).get_function_info();
let add = |a: i32, b: i32| total = a + b;

// Sanity check:
assert_eq!(
std::any::type_name_of_val(&add),
"bevy_reflect::func::info::tests::should_create_closure_info::{{closure}}"
);

let info = add.get_function_info();
assert!(info.name().is_none());
assert_eq!(info.arg_count(), 2);
assert_eq!(info.args()[0].type_path(), "i32");
Expand Down