Change World::try_despawn and World::try_insert_batch to return Result
#17376
+188
−136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BenjaminBrienen
added
C-Feature
BenjaminBrienen
suggested changes
Jan 15, 2025
Comment on lines
+2616
to
+2617
| // This is effectively in an `else` block, since it can only be reached if the | ||
| // above `if` fails. |
There was a problem hiding this comment.
Suggested change
| // This is effectively in an `else` block, since it can only be reached if the | |
| // above `if` fails. |
| /// [`World::try_despawn`]: crate::world::World::try_despawn | ||
| #[derive(Error, Debug, Clone, Copy)] | ||
| #[error("Could not despawn the entity with ID {0} because it {1}")] | ||
| pub struct TryDespawnError(pub Entity, pub EntityDoesNotExistDetails); |
There was a problem hiding this comment.
Named structs instead of tuple structs please. Operations on tuple structs are much less clear, so we avoid them as a matter of style unless they're 1-element newtypes.
| @@ -2332,7 +2354,7 @@ impl World { | |||
| /// | |||
| /// This function will panic if any of the associated entities do not exist. | |||
| /// | |||
| /// For the non-panicking version, see [`World::try_insert_batch`]. | |||
| /// For the fallible version, see [`World::try_insert_batch`]. | |||
| #[track_caller] | |||
| pub fn insert_batch<I, B>(&mut self, batch: I) | |||
There was a problem hiding this comment.
I would prefer to merge all of the fallible / infallible variants, but that should be done in follow-up.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Most
trymethods onWorldreturn aResult, buttry_despawnandtry_insert_batchdon't. Since Bevy's error handling is advancing, these should be brought in line.Solution
TryDespawnErrorandTryInsertBatchError.try_despawn,try_insert_batch, andtry_insert_batch_if_newnow return their respective errors.try_insert_batch_with_callerto support collecting invalid entities.Migration Guide
World::try_despawnnow returns aResultrather than abool.World::try_insert_batchandWorld::try_insert_batch_if_newnow return aResultwhere they previously returned nothing.