Updates for rust 1.73 (bevyengine#10035)

# Objective - Updates for rust 1.73 ## Solution - new doc check for `redundant_explicit_links` - updated to text for compile fail tests --- ## Changelog - updates for rust 1.73
rdrpenguin04 · Jan 9, 2024 · 44c1ce7 · 44c1ce7
1 parent 392ef7f
commit 44c1ce7
Show file tree

Hide file tree

Showing 44 changed files with 136 additions and 136 deletions.
diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs
@@ -334,7 +334,7 @@ impl App {
     /// initial state.
     ///
     /// If you would like to control how other systems run based on the current state,
-    /// you can emulate this behavior using the [`in_state`] [`Condition`](bevy_ecs::schedule::Condition).
+    /// you can emulate this behavior using the [`in_state`] [`Condition`].
     ///
     /// Note that you can also apply state transitions at other points in the schedule
     /// by adding the [`apply_state_transition`] system manually.

diff --git a/crates/bevy_app/src/plugin.rs b/crates/bevy_app/src/plugin.rs
@@ -51,7 +51,7 @@ pub trait Plugin: Downcast + Any + Send + Sync {
         std::any::type_name::<Self>()
     }
 
-    /// If the plugin can be meaningfully instantiated several times in an [`App`](crate::App),
+    /// If the plugin can be meaningfully instantiated several times in an [`App`],
     /// override this method to return `false`.
     fn is_unique(&self) -> bool {
         true

diff --git a/crates/bevy_audio/src/audio_output.rs b/crates/bevy_audio/src/audio_output.rs
@@ -13,7 +13,7 @@ use crate::AudioSink;
 ///
 /// ## Note
 ///
-/// Initializing this resource will leak [`rodio::OutputStream`](rodio::OutputStream)
+/// Initializing this resource will leak [`rodio::OutputStream`]
 /// using [`std::mem::forget`].
 /// This is done to avoid storing this in the struct (and making this `!Send`)
 /// while preventing it from dropping (to avoid halting of audio).

diff --git a/crates/bevy_ecs/src/change_detection.rs b/crates/bevy_ecs/src/change_detection.rs
@@ -535,7 +535,7 @@ impl_debug!(Res<'w, T>, Resource);
 ///
 /// See the [`Resource`] documentation for usage.
 ///
-/// If you need a shared borrow, use [`Res`](crate::system::Res) instead.
+/// If you need a shared borrow, use [`Res`] instead.
 ///
 /// # Panics
 ///

diff --git a/crates/bevy_ecs/src/component.rs b/crates/bevy_ecs/src/component.rs
@@ -266,7 +266,7 @@ impl ComponentInfo {
 }
 
 /// A value which uniquely identifies the type of a [`Component`] within a
-/// [`World`](crate::world::World).
+/// [`World`].
 ///
 /// Each time a new `Component` type is registered within a `World` using
 /// [`World::init_component`](crate::world::World::init_component) or

diff --git a/crates/bevy_ecs/src/query/filter.rs b/crates/bevy_ecs/src/query/filter.rs
@@ -616,10 +616,10 @@ impl_tick_filter!(
 
 /// A marker trait to indicate that the filter works at an archetype level.
 ///
-/// This is needed to implement [`ExactSizeIterator`](std::iter::ExactSizeIterator) for
+/// This is needed to implement [`ExactSizeIterator`] for
 /// [`QueryIter`](crate::query::QueryIter) that contains archetype-level filters.
 ///
-/// The trait must only be implement for filters where its corresponding [`WorldQuery::IS_ARCHETYPAL`](crate::query::WorldQuery::IS_ARCHETYPAL)
+/// The trait must only be implement for filters where its corresponding [`WorldQuery::IS_ARCHETYPAL`]
 /// is [`prim@true`]. As such, only the [`With`] and [`Without`] filters can implement the trait.
 /// [Tuples](prim@tuple) and [`Or`] filters are automatically implemented with the trait only if its containing types
 /// also implement the same trait.

diff --git a/crates/bevy_ecs/src/schedule/schedule.rs b/crates/bevy_ecs/src/schedule/schedule.rs
@@ -274,7 +274,7 @@ impl Schedule {
 
     /// Set whether the schedule applies deferred system buffers on final time or not. This is a catch-all
     /// in case a system uses commands but was not explicitly ordered before an instance of
-    /// [`apply_deferred`](crate::prelude::apply_deferred). By default this
+    /// [`apply_deferred`]. By default this
     /// setting is true, but may be disabled if needed.
     pub fn set_apply_final_deferred(&mut self, apply_final_deferred: bool) -> &mut Self {
         self.executor.set_apply_final_deferred(apply_final_deferred);

diff --git a/crates/bevy_ecs/src/system/mod.rs b/crates/bevy_ecs/src/system/mod.rs
@@ -6,7 +6,7 @@
 //!
 //! System functions can have parameters, through which one can query and mutate Bevy ECS state.
 //! Only types that implement [`SystemParam`] can be used, automatically fetching data from
-//! the [`World`](crate::world::World).
+//! the [`World`].
 //!
 //! System functions often look like this:
 //!

diff --git a/crates/bevy_ecs/src/world/mod.rs b/crates/bevy_ecs/src/world/mod.rs
@@ -383,7 +383,7 @@ impl World {
         }
     }
 
-    /// Returns the components of an [`Entity`](crate::entity::Entity) through [`ComponentInfo`](crate::component::ComponentInfo).
+    /// Returns the components of an [`Entity`] through [`ComponentInfo`].
     #[inline]
     pub fn inspect_entity(&self, entity: Entity) -> Vec<&ComponentInfo> {
         let entity_location = self
@@ -1766,7 +1766,7 @@ impl World {
     /// Iterates all component change ticks and clamps any older than [`MAX_CHANGE_AGE`](crate::change_detection::MAX_CHANGE_AGE).
     /// This prevents overflow and thus prevents false positives.
     ///
-    /// **Note:** Does nothing if the [`World`] counter has not been incremented at least [`CHECK_TICK_THRESHOLD`](crate::change_detection::CHECK_TICK_THRESHOLD)
+    /// **Note:** Does nothing if the [`World`] counter has not been incremented at least [`CHECK_TICK_THRESHOLD`]
     /// times since the previous pass.
     // TODO: benchmark and optimize
     pub fn check_change_ticks(&mut self) {

diff --git a/crates/bevy_ecs/src/world/unsafe_world_cell.rs b/crates/bevy_ecs/src/world/unsafe_world_cell.rs
@@ -26,14 +26,14 @@ use std::{any::TypeId, cell::UnsafeCell, fmt::Debug, marker::PhantomData};
 /// In rust, having a `&mut World` means that there are absolutely no other references to the safe world alive at the same time,
 /// without exceptions. Not even unsafe code can change this.
 ///
-/// But there are situations where careful shared mutable access through a type is possible and safe. For this, rust provides the [`UnsafeCell`](std::cell::UnsafeCell)
+/// But there are situations where careful shared mutable access through a type is possible and safe. For this, rust provides the [`UnsafeCell`]
 /// escape hatch, which allows you to get a `*mut T` from a `&UnsafeCell<T>` and around which safe abstractions can be built.
 ///
 /// Access to resources and components can be done uniquely using [`World::resource_mut`] and [`World::entity_mut`], and shared using [`World::resource`] and [`World::entity`].
 /// These methods use lifetimes to check at compile time that no aliasing rules are being broken.
 ///
 /// This alone is not enough to implement bevy systems where multiple systems can access *disjoint* parts of the world concurrently. For this, bevy stores all values of
-/// resources and components (and [`ComponentTicks`](crate::component::ComponentTicks)) in [`UnsafeCell`](std::cell::UnsafeCell)s, and carefully validates disjoint access patterns using
+/// resources and components (and [`ComponentTicks`]) in [`UnsafeCell`]s, and carefully validates disjoint access patterns using
 /// APIs like [`System::component_access`](crate::system::System::component_access).
 ///
 /// A system then can be executed using [`System::run_unsafe`](crate::system::System::run_unsafe) with a `&World` and use methods with interior mutability to access resource values.
@@ -909,7 +909,7 @@ impl<'w> UnsafeWorldCell<'w> {
     }
 }
 
-/// Get an untyped pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`] in the provided [`World`](crate::world::World).
+/// Get an untyped pointer to a particular [`Component`] on a particular [`Entity`] in the provided [`World`].
 ///
 /// # Safety
 /// - `location` must refer to an archetype that contains `entity`
@@ -937,7 +937,7 @@ unsafe fn get_component(
     }
 }
 
-/// Get an untyped pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`]
+/// Get an untyped pointer to a particular [`Component`] and its [`ComponentTicks`]
 ///
 /// # Safety
 /// - `location` must refer to an archetype that contains `entity`

diff --git a/crates/bevy_ecs/src/world/world_cell.rs b/crates/bevy_ecs/src/world/world_cell.rs
@@ -336,19 +336,19 @@ impl<'w> WorldCell<'w> {
         }
     }
 
-    /// Sends an [`Event`](crate::event::Event).
+    /// Sends an [`Event`].
     #[inline]
     pub fn send_event<E: Event>(&self, event: E) {
         self.send_event_batch(std::iter::once(event));
     }
 
-    /// Sends the default value of the [`Event`](crate::event::Event) of type `E`.
+    /// Sends the default value of the [`Event`] of type `E`.
     #[inline]
     pub fn send_event_default<E: Event + Default>(&self) {
         self.send_event_batch(std::iter::once(E::default()));
     }
 
-    /// Sends a batch of [`Event`](crate::event::Event)s from an iterator.
+    /// Sends a batch of [`Event`]s from an iterator.
     #[inline]
     pub fn send_event_batch<E: Event>(&self, events: impl Iterator<Item = E>) {
         match self.get_resource_mut::<Events<E>>() {

diff --git a/crates/bevy_ecs_compile_fail_tests/tests/ui/entity_ref_mut_lifetime_safety.stderr b/crates/bevy_ecs_compile_fail_tests/tests/ui/entity_ref_mut_lifetime_safety.stderr
@@ -2,7 +2,7 @@ error[E0502]: cannot borrow `e_mut` as mutable because it is also borrowed as im
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:17:26
    |
 16 |         let gotten: &A = e_mut.get::<A>().unwrap();
-   |                          ---------------- immutable borrow occurs here
+   |                          ----- immutable borrow occurs here
 17 |         let gotten2: A = e_mut.take::<A>().unwrap();
    |                          ^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 18 |         assert_eq!(gotten, &gotten2); // oops UB
@@ -12,9 +12,9 @@ error[E0499]: cannot borrow `e_mut` as mutable more than once at a time
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:25:30
    |
 24 |         let mut gotten: Mut<A> = e_mut.get_mut::<A>().unwrap();
-   |                                  -------------------- first mutable borrow occurs here
+   |                                  ----- first mutable borrow occurs here
 25 |         let mut gotten2: A = e_mut.take::<A>().unwrap();
-   |                              ^^^^^^^^^^^^^^^^^ second mutable borrow occurs here
+   |                              ^^^^^ second mutable borrow occurs here
 26 |         assert_eq!(&mut *gotten, &mut gotten2); // oops UB
    |                          ------ first borrow later used here
 
@@ -25,7 +25,7 @@ error[E0505]: cannot move out of `e_mut` because it is borrowed
    |         --------- binding `e_mut` declared here
 ...
 32 |         let gotten: &A = e_mut.get::<A>().unwrap();
-   |                          ---------------- borrow of `e_mut` occurs here
+   |                          ----- borrow of `e_mut` occurs here
 33 |         e_mut.despawn();
    |         ^^^^^ move out of `e_mut` occurs here
 34 |         assert_eq!(gotten, &A(Box::new(14_usize))); // oops UB
@@ -35,7 +35,7 @@ error[E0502]: cannot borrow `e_mut` as mutable because it is also borrowed as im
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:42:34
    |
 41 |         let gotten: &A = e_mut.get::<A>().unwrap();
-   |                          ---------------- immutable borrow occurs here
+   |                          ----- immutable borrow occurs here
 42 |         let gotten_mut: Mut<A> = e_mut.get_mut::<A>().unwrap();
    |                                  ^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 43 |         assert_eq!(gotten, &*gotten_mut); // oops UB
@@ -45,17 +45,17 @@ error[E0502]: cannot borrow `e_mut` as immutable because it is also borrowed as
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:48:26
    |
 47 |         let gotten_mut: Mut<A> = e_mut.get_mut::<A>().unwrap();
-   |                                  -------------------- mutable borrow occurs here
+   |                                  ----- mutable borrow occurs here
 48 |         let gotten: &A = e_mut.get::<A>().unwrap();
-   |                          ^^^^^^^^^^^^^^^^ immutable borrow occurs here
+   |                          ^^^^^ immutable borrow occurs here
 49 |         assert_eq!(gotten, &*gotten_mut); // oops UB
    |                              ---------- mutable borrow later used here
 
 error[E0502]: cannot borrow `e_mut` as mutable because it is also borrowed as immutable
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:54:9
    |
 53 |         let gotten: &A = e_mut.get::<A>().unwrap();
-   |                          ---------------- immutable borrow occurs here
+   |                          ----- immutable borrow occurs here
 54 |         e_mut.insert::<B>(B);
    |         ^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 55 |         assert_eq!(gotten, &A(Box::new(16_usize))); // oops UB
@@ -65,8 +65,8 @@ error[E0499]: cannot borrow `e_mut` as mutable more than once at a time
   --> tests/ui/entity_ref_mut_lifetime_safety.rs:61:9
    |
 60 |         let mut gotten_mut: Mut<A> = e_mut.get_mut::<A>().unwrap();
-   |                                      -------------------- first mutable borrow occurs here
+   |                                      ----- first mutable borrow occurs here
 61 |         e_mut.insert::<B>(B);
-   |         ^^^^^^^^^^^^^^^^^^^^ second mutable borrow occurs here
+   |         ^^^^^ second mutable borrow occurs here
 62 |         assert_eq!(&mut *gotten_mut, &mut A(Box::new(16_usize))); // oops UB
    |                          ---------- first borrow later used here
diff --git a/crates/bevy_ecs_compile_fail_tests/tests/ui/query_lifetime_safety.stderr b/crates/bevy_ecs_compile_fail_tests/tests/ui/query_lifetime_safety.stderr
@@ -2,7 +2,7 @@ error[E0502]: cannot borrow `query` as mutable because it is also borrowed as im
   --> tests/ui/query_lifetime_safety.rs:17:39
    |
 16 |             let data: &Foo = query.get(e).unwrap();
-   |                              ------------ immutable borrow occurs here
+   |                              ----- immutable borrow occurs here
 17 |             let mut data2: Mut<Foo> = query.get_mut(e).unwrap();
    |                                       ^^^^^^^^^^^^^^^^ mutable borrow occurs here
 18 |             assert_eq!(data, &mut *data2); // oops UB
@@ -12,17 +12,17 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:23:30
    |
 22 |             let mut data2: Mut<Foo> = query.get_mut(e).unwrap();
-   |                                       ---------------- mutable borrow occurs here
+   |                                       ----- mutable borrow occurs here
 23 |             let data: &Foo = query.get(e).unwrap();
-   |                              ^^^^^^^^^^^^ immutable borrow occurs here
+   |                              ^^^^^ immutable borrow occurs here
 24 |             assert_eq!(data, &mut *data2); // oops UB
    |                                    ----- mutable borrow later used here
 
 error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
   --> tests/ui/query_lifetime_safety.rs:29:39
    |
 28 |             let data: &Foo = query.get_component::<Foo>(e).unwrap();
-   |                              ----------------------------- immutable borrow occurs here
+   |                              ----- immutable borrow occurs here
 29 |             let mut data2: Mut<Foo> = query.get_component_mut(e).unwrap();
    |                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 30 |             assert_eq!(data, &mut *data2); // oops UB
@@ -32,17 +32,17 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:35:30
    |
 34 |             let mut data2: Mut<Foo> = query.get_component_mut(e).unwrap();
-   |                                       -------------------------- mutable borrow occurs here
+   |                                       ----- mutable borrow occurs here
 35 |             let data: &Foo = query.get_component::<Foo>(e).unwrap();
-   |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ immutable borrow occurs here
+   |                              ^^^^^ immutable borrow occurs here
 36 |             assert_eq!(data, &mut *data2); // oops UB
    |                                    ----- mutable borrow later used here
 
 error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
   --> tests/ui/query_lifetime_safety.rs:41:39
    |
 40 |             let data: &Foo = query.single();
-   |                              -------------- immutable borrow occurs here
+   |                              ----- immutable borrow occurs here
 41 |             let mut data2: Mut<Foo> = query.single_mut();
    |                                       ^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 42 |             assert_eq!(data, &mut *data2); // oops UB
@@ -52,17 +52,17 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:47:30
    |
 46 |             let mut data2: Mut<Foo> = query.single_mut();
-   |                                       ------------------ mutable borrow occurs here
+   |                                       ----- mutable borrow occurs here
 47 |             let data: &Foo = query.single();
-   |                              ^^^^^^^^^^^^^^ immutable borrow occurs here
+   |                              ^^^^^ immutable borrow occurs here
 48 |             assert_eq!(data, &mut *data2); // oops UB
    |                                    ----- mutable borrow later used here
 
 error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
   --> tests/ui/query_lifetime_safety.rs:53:39
    |
 52 |             let data: &Foo = query.get_single().unwrap();
-   |                              ------------------ immutable borrow occurs here
+   |                              ----- immutable borrow occurs here
 53 |             let mut data2: Mut<Foo> = query.get_single_mut().unwrap();
    |                                       ^^^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 54 |             assert_eq!(data, &mut *data2); // oops UB
@@ -72,17 +72,17 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:59:30
    |
 58 |             let mut data2: Mut<Foo> = query.get_single_mut().unwrap();
-   |                                       ---------------------- mutable borrow occurs here
+   |                                       ----- mutable borrow occurs here
 59 |             let data: &Foo = query.get_single().unwrap();
-   |                              ^^^^^^^^^^^^^^^^^^ immutable borrow occurs here
+   |                              ^^^^^ immutable borrow occurs here
 60 |             assert_eq!(data, &mut *data2); // oops UB
    |                                    ----- mutable borrow later used here
 
 error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
   --> tests/ui/query_lifetime_safety.rs:65:39
    |
 64 |             let data: &Foo = query.iter().next().unwrap();
-   |                              ------------ immutable borrow occurs here
+   |                              ----- immutable borrow occurs here
 65 |             let mut data2: Mut<Foo> = query.iter_mut().next().unwrap();
    |                                       ^^^^^^^^^^^^^^^^ mutable borrow occurs here
 66 |             assert_eq!(data, &mut *data2); // oops UB
@@ -92,17 +92,17 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:71:30
    |
 70 |             let mut data2: Mut<Foo> = query.iter_mut().next().unwrap();
-   |                                       ---------------- mutable borrow occurs here
+   |                                       ----- mutable borrow occurs here
 71 |             let data: &Foo = query.iter().next().unwrap();
-   |                              ^^^^^^^^^^^^ immutable borrow occurs here
+   |                              ^^^^^ immutable borrow occurs here
 72 |             assert_eq!(data, &mut *data2); // oops UB
    |                                    ----- mutable borrow later used here
 
 error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
   --> tests/ui/query_lifetime_safety.rs:79:13
    |
 78 |             query.for_each(|data| opt_data = Some(data));
-   |             -------------------------------------------- immutable borrow occurs here
+   |             ----- immutable borrow occurs here
 79 |             query.for_each_mut(|data| opt_data_2 = Some(data));
    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ mutable borrow occurs here
 80 |             assert_eq!(opt_data.unwrap(), &mut *opt_data_2.unwrap()); // oops UB
@@ -112,8 +112,8 @@ error[E0502]: cannot borrow `query` as immutable because it is also borrowed as
   --> tests/ui/query_lifetime_safety.rs:87:13
    |
 86 |             query.for_each_mut(|data| opt_data_2 = Some(data));
-   |             -------------------------------------------------- mutable borrow occurs here
+   |             ----- mutable borrow occurs here
 87 |             query.for_each(|data| opt_data = Some(data));
-   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ immutable borrow occurs here
+   |             ^^^^^ immutable borrow occurs here
 88 |             assert_eq!(opt_data.unwrap(), &mut *opt_data_2.unwrap()); // oops UB
    |                                                 ---------- mutable borrow later used here