Rename bevy_ecs::world::Entry to ComponentEntry #19517
Open
+44
−35
Conversation
This file contains hidden or 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
6 tasks
alice-i-cecile
added
A-ECS
|
Ping @urben1680 for review :) |
urben1680
suggested changes
Jun 6, 2025
There was a problem hiding this comment.
Just a few docs that need to be updated.
I cannot mark everything because it is not close enough to the changes, so here is a list of what I saw in entity_ref.rs:
- line 2578, just rename "Entry" to "entry", no need to name the whole type when other docs also just call it "entry"
- line 3025 a comment should be adjusted from "OccupiedEntry" to "OccupiedComponentEntry"
- line 3081 has `Entry` so that might want to be the correct full type.
- line 3331 `OccupiedEntry` -> `OccupiedComponentEntry`
| } | ||
| } | ||
| } | ||
|
|
||
| impl<'w, 'a, T: Component> Entry<'w, 'a, T> { | ||
| impl<'w, 'a, T: Component> ComponentEntry<'w, 'a, T> { | ||
| /// Replaces the component of the entry, and returns an [`OccupiedEntry`]. |
There was a problem hiding this comment.
Suggested change
| /// Replaces the component of the entry, and returns an [`OccupiedEntry`]. | |
| /// Replaces the component of the entry, and returns an [`OccupiedComponentEntry`]. |
| Entry::Occupied(entry) => entry, | ||
| Entry::Vacant(entry) => entry.insert(Default::default()), | ||
| ComponentEntry::Occupied(entry) => entry, | ||
| ComponentEntry::Vacant(entry) => entry.insert(Default::default()), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// A view into an occupied entry in a [`EntityWorldMut`]. It is part of the [`Entry`] enum. |
There was a problem hiding this comment.
Suggested change
| /// A view into an occupied entry in a [`EntityWorldMut`]. It is part of the [`Entry`] enum. | |
| /// A view into an occupied entry in a [`EntityWorldMut`]. It is part of the [`ComponentEntry`] enum. |
| @@ -3139,12 +3139,12 @@ impl<'w, 'a, T: Component<Mutability = Mutable>> OccupiedEntry<'w, 'a, T> { | |||
| } | |||
|
|
|||
| /// A view into a vacant entry in a [`EntityWorldMut`]. It is part of the [`Entry`] enum. | |||
There was a problem hiding this comment.
Suggested change
| /// A view into a vacant entry in a [`EntityWorldMut`]. It is part of the [`Entry`] enum. | |
| /// A view into a vacant entry in a [`EntityWorldMut`]. It is part of the [`ComponentEntry`] enum. |
| entity_world: &'a mut EntityWorldMut<'w>, | ||
| _marker: PhantomData<T>, | ||
| } | ||
|
|
||
| impl<'w, 'a, T: Component> VacantEntry<'w, 'a, T> { | ||
| impl<'w, 'a, T: Component> VacantComponentEntry<'w, 'a, T> { | ||
| /// Inserts the component into the `VacantEntry` and returns an `OccupiedEntry`. |
There was a problem hiding this comment.
Suggested change
| /// Inserts the component into the `VacantEntry` and returns an `OccupiedEntry`. | |
| /// Inserts the component into the `VacantComponentEntry` and returns an `OccupiedComponentEntry`. |
alice-i-cecile
added
S-Waiting-on-Author
Carter0
approved these changes
Jun 8, 2025
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
As discussed in #19285, some of our names conflict.
Entryin bevy_ecs is one of those overly general names.Solution
Rename this type (and the related types) to
ComponentEntry.