bevy/crates/bevy_ecs_compile_fail_tests/tests/ui
Carter Anderson 01aedc8431 Spawn now takes a Bundle (#6054)
# Objective

Now that we can consolidate Bundles and Components under a single insert (thanks to #2975 and #6039), almost 100% of world spawns now look like `world.spawn().insert((Some, Tuple, Here))`. Spawning an entity without any components is an extremely uncommon pattern, so it makes sense to give spawn the "first class" ergonomic api. This consolidated api should be made consistent across all spawn apis (such as World and Commands).

## Solution

All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input:

```rust
// before:
commands
  .spawn()
  .insert((A, B, C));
world
  .spawn()
  .insert((A, B, C);

// after
commands.spawn((A, B, C));
world.spawn((A, B, C));
```

All existing instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api. A new `spawn_empty` has been added, replacing the old `spawn` api.  

By allowing `world.spawn(some_bundle)` to replace `world.spawn().insert(some_bundle)`, this opened the door to removing the initial entity allocation in the "empty" archetype / table done in `spawn()` (and subsequent move to the actual archetype in `.insert(some_bundle)`).

This improves spawn performance by over 10%:
![image](https://user-images.githubusercontent.com/2694663/191627587-4ab2f949-4ccd-4231-80eb-80dd4d9ad6b9.png)

To take this measurement, I added a new `world_spawn` benchmark.

Unfortunately, optimizing `Commands::spawn` is slightly less trivial, as Commands expose the Entity id of spawned entities prior to actually spawning. Doing the optimization would (naively) require assurances that the `spawn(some_bundle)` command is applied before all other commands involving the entity (which would not necessarily be true, if memory serves). Optimizing `Commands::spawn` this way does feel possible, but it will require careful thought (and maybe some additional checks), which deserves its own PR. For now, it has the same performance characteristics of the current `Commands::spawn_bundle` on main.

**Note that 99% of this PR is simple renames and refactors. The only code that needs careful scrutiny is the new `World::spawn()` impl, which is relatively straightforward, but it has some new unsafe code (which re-uses battle tested BundlerSpawner code path).** 

---

## Changelog

- All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input
- All instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api
- World and Commands now have `spawn_empty()`, which is equivalent to the old `spawn()` behavior.  

## Migration Guide

```rust
// Old (0.8):
commands
  .spawn()
  .insert_bundle((A, B, C));
// New (0.9)
commands.spawn((A, B, C));

// Old (0.8):
commands.spawn_bundle((A, B, C));
// New (0.9)
commands.spawn((A, B, C));

// Old (0.8):
let entity = commands.spawn().id();
// New (0.9)
let entity = commands.spawn_empty().id();

// Old (0.8)
let entity = world.spawn().id();
// New (0.9)
let entity = world.spawn_empty();
```
2022-09-23 19:55:54 +00:00
..
entity_ref_mut_lifetime_safety.rs Spawn now takes a Bundle (#6054) 2022-09-23 19:55:54 +00:00
entity_ref_mut_lifetime_safety.stderr REMOVE unsound lifetime annotations on EntityMut (#4096) 2022-04-04 21:33:33 +00:00
query_combin_exact_sized_iterator_safety.rs Add ExactSizeIterator implementation for QueryCombinatonIter (#5148) 2022-07-13 16:08:48 +00:00
query_combin_exact_sized_iterator_safety.stderr Fix CI issues arising from use of Rust 1.64 (#6067) 2022-09-22 16:56:43 +00:00
query_exact_sized_iterator_safety.rs Update ExactSizeIterator impl to support archetypal filters (With, Without) (#5124) 2022-06-29 02:15:28 +00:00
query_exact_sized_iterator_safety.stderr remove QF generics from all Query/State methods and types (#5170) 2022-07-19 00:45:00 +00:00
query_iter_combinations_mut_iterator_safety.rs Replace many_for_each_mut with iter_many_mut. (#5402) 2022-07-30 01:38:13 +00:00
query_iter_combinations_mut_iterator_safety.stderr Fix CI issues arising from use of Rust 1.64 (#6067) 2022-09-22 16:56:43 +00:00
query_iter_many_mut_iterator_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
query_iter_many_mut_iterator_safety.stderr Fix CI issues arising from use of Rust 1.64 (#6067) 2022-09-22 16:56:43 +00:00
query_lifetime_safety.rs Spawn now takes a Bundle (#6054) 2022-09-23 19:55:54 +00:00
query_lifetime_safety.stderr yeet unsound lifetime annotations on Query methods (#4243) 2022-03-22 02:49:41 +00:00
query_to_readonly.rs Allows conversion of mutable queries to immutable queries (#5376) 2022-07-20 01:09:45 +00:00
query_to_readonly.stderr Allows conversion of mutable queries to immutable queries (#5376) 2022-07-20 01:09:45 +00:00
system_param_derive_readonly.rs Make derived SystemParam readonly if possible (#4650) 2022-05-09 16:09:33 +00:00
system_param_derive_readonly.stderr make WorldQuery very flat (#5205) 2022-08-04 21:51:02 +00:00
system_query_get_lifetime_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_get_lifetime_safety.stderr Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_get_many_lifetime_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_get_many_lifetime_safety.stderr Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_get_many_mut_lifetime_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_get_many_mut_lifetime_safety.stderr Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_iter_lifetime_safety.rs Assert compiler errors for compile_fail tests (#3067) 2021-11-13 22:43:19 +00:00
system_query_iter_lifetime_safety.stderr Fix clippy lints for 1.57 (#3238) 2021-12-02 23:40:37 +00:00
system_query_iter_many_mut_lifetime_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_iter_many_mut_lifetime_safety.stderr Replace many_for_each_mut with iter_many_mut. (#5402) 2022-07-30 01:38:13 +00:00
system_query_set_get_lifetime_safety.rs Make Resource trait opt-in, requiring #[derive(Resource)] V2 (#5577) 2022-08-08 21:36:35 +00:00
system_query_set_get_lifetime_safety.stderr ParamSet for conflicting SystemParam:s (#2765) 2022-03-29 23:39:38 +00:00
system_query_set_iter_lifetime_safety.rs ParamSet for conflicting SystemParam:s (#2765) 2022-03-29 23:39:38 +00:00
system_query_set_iter_lifetime_safety.stderr ParamSet for conflicting SystemParam:s (#2765) 2022-03-29 23:39:38 +00:00
system_state_get_lifetime_safety.rs Assert compiler errors for compile_fail tests (#3067) 2021-11-13 22:43:19 +00:00
system_state_get_lifetime_safety.stderr Assert compiler errors for compile_fail tests (#3067) 2021-11-13 22:43:19 +00:00
system_state_iter_lifetime_safety.rs Assert compiler errors for compile_fail tests (#3067) 2021-11-13 22:43:19 +00:00
system_state_iter_lifetime_safety.stderr Assert compiler errors for compile_fail tests (#3067) 2021-11-13 22:43:19 +00:00
system_state_iter_mut_overlap_safety.rs Spawn now takes a Bundle (#6054) 2022-09-23 19:55:54 +00:00
system_state_iter_mut_overlap_safety.stderr Fix clippy lints for 1.57 (#3238) 2021-12-02 23:40:37 +00:00
world_query_derive.rs Introduce tests for derive(WorldQuery) (#4625) 2022-04-28 21:06:20 +00:00
world_query_derive.stderr remove QF generics from all Query/State methods and types (#5170) 2022-07-19 00:45:00 +00:00