Skip to content

Add doctest example for QueryState to to direct users to World::try_query for easy QueryState construction #22224

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

Closed
IronGremlin wants to merge 2 commits into from
Closed

Add doctest example for QueryState to to direct users to World::try_query for easy QueryState construction #22224

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59702ea
Add doctest example to to direct users to for easy construction
IronGremlin Dec 21, 2025
e3247c9
resolve typo
IronGremlin Dec 21, 2025
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
20 changes: 20 additions & 0 deletions crates/bevy_ecs/src/query/state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,26 @@ pub(super) union StorageId {
/// [`State`]: crate::query::world_query::WorldQuery::State
/// [`Fetch`]: crate::query::world_query::WorldQuery::Fetch
/// [`Table`]: crate::storage::Table
///
/// Note:
///
/// Constructing a [`QueryState`] for query execution can be made straightforward with the use of [`World::try_query`] or
/// [`World::try_query_filtered`].
///
/// Example:
///
/// ```rust
/// # use bevy_ecs::{prelude::*, world::DeferredWorld};
/// #[derive(Component)]
/// struct MainCamera;
///
/// let mut world = World::new();
/// let e1 = world.spawn((Camera2d::default(),MainCamera)).id();
/// let query_state = world.try_query_filtered::<(Entity,&Camera), With<MainCamera>>().unwrap();
/// let (camera_entity, camera) = world.query(&query_state).single().unwrap();
/// # _world.flush();
/// assert_eq!(camera_entity, e1);
/// ```
#[repr(C)]
// SAFETY NOTE:
// Do not add any new fields that use the `D` or `F` generic parameters as this may
Expand Down
Loading