[Merged by Bors] - move system_param fetch struct into anonymous scope to avoid name collisions #4100
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
|
Is there a reason we don't use the I think this code might have been originally written before that technique was known? |
robtfm
changed the title
alice-i-cecile
added
A-ECS
alice-i-cecile
approved these changes
Mar 5, 2022
james7132
approved these changes
Mar 8, 2022
james7132
added
the
S-Ready-For-Final-Review
|
@robtfm this is a good change that I'd like to merge. Can you rebase? |
robtfm
force-pushed
the
sysparam_struct_name
branch
from
4e80f3a
to
b68ae8d
Compare
|
just want to flag that this is a public api breaking change that will affect at least one 3rd party crate (bevy-console). i think that doesn't automatically make it "controversial", but i am not up to date on all the new process discussions. |
|
I disagree that this is a public api breaking change - the implementation details of the |
|
it uses the fetch struct for manual event reader/writers: https://github.com/RichoDemus/bevy-console/blob/6bfa88d357a45df2ea117d445691fe1dd4dcb8b7/src/console.rs#L301. |
alice-i-cecile
added
the
M-Needs-Migration-Guide
|
@robftm can you add a very short migration guide to the PR description? Very niche, but it's nice to have some insight into why unusual code broke. |
added, largely mirroring the comment |
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
|
This PR was included in a batch that was canceled, it will be automatically retried |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
|
Build failed (retrying...): |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
|
This PR was included in a batch that was canceled, it will be automatically retried |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
|
This PR was included in a batch that timed out, it will be automatically retried |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
|
This PR was included in a batch that timed out, it will be automatically retried |
bors bot
pushed a commit
that referenced
this pull request
May 2, 2022
…lisions (#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
bors
bot
changed the title
exjam
pushed a commit
to exjam/bevy
that referenced
this pull request
May 22, 2022
…lisions (bevyengine#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…lisions (bevyengine#4100) # Objective avoid naming collisions with user structs when deriving ``system_param``. ## Solution ~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~ place the fetch struct into an anonymous scope. ## Migration Guide For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
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
avoid naming collisions with user structs when deriving
system_param.Solution
rename the fetch struct created by#[derive(system_param)]from{}Stateto{}SysParamState.place the fetch struct into an anonymous scope.
Migration Guide
For code that was using a system param's fetch struct, such as
EventReader'sEventReaderState, the fetch struct can now be identified via the SystemParam trait associated typeFetch, e.g. forEventReader<T>it can be identified as<EventReader<'static, 'static, T> as SystemParam>::Fetch