109 lines
90 KiB
HTML
109 lines
90 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Unique mutable borrow of a `Resource`."><title>ResMut in bevy_ecs::change_detection - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_ecs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bevy_ecs/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_ecs/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_ecs/index.html">bevy_<wbr>ecs</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ResMut</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_deref_mut" title="as_deref_mut">as_deref_mut</a></li><li><a href="#method.filter_map_unchanged" title="filter_map_unchanged">filter_map_unchanged</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.map_unchanged" title="map_unchanged">map_unchanged</a></li><li><a href="#method.reborrow" title="reborrow">reborrow</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-AsMut%3CT%3E-for-ResMut%3C'w,+T%3E" title="AsMut<T>">AsMut<T></a></li><li><a href="#impl-AsRef%3CT%3E-for-ResMut%3C'w,+T%3E" title="AsRef<T>">AsRef<T></a></li><li><a href="#impl-Debug-for-ResMut%3C'w,+T%3E" title="Debug">Debug</a></li><li><a href="#impl-Deref-for-ResMut%3C'w,+T%3E" title="Deref">Deref</a></li><li><a href="#impl-DerefMut-for-ResMut%3C'w,+T%3E" title="DerefMut">DerefMut</a></li><li><a href="#impl-DetectChanges-for-ResMut%3C'w,+T%3E" title="DetectChanges">DetectChanges</a></li><li><a href="#impl-DetectChangesMut-for-ResMut%3C'w,+T%3E" title="DetectChangesMut">DetectChangesMut</a></li><li><a href="#impl-From%3CResMut%3C'w,+T%3E%3E-for-Mut%3C'w,+T%3E" title="From<ResMut<'w, T>>">From<ResMut<'w, T>></a></li><li><a href="#impl-From%3CResMut%3C'w,+T%3E%3E-for-Res%3C'w,+T%3E" title="From<ResMut<'w, T>>">From<ResMut<'w, T>></a></li><li><a href="#impl-IntoIterator-for-%26ResMut%3C'w,+T%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26mut+ResMut%3C'w,+T%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-SystemParam-for-ResMut%3C'a,+T%3E" title="SystemParam">SystemParam</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-UnwindSafe-for-ResMut%3C'w,+T%3E" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-ResMut%3C'w,+T%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ResMut%3C'w,+T%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ResMut%3C'w,+T%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-ResMut%3C'w,+T%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-ResMut%3C'w,+T%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-ConditionalSend-for-T" title="ConditionalSend">ConditionalSend</a></li><li><a href="#impl-Downcast-for-T" title="Downcast">Downcast</a></li><li><a href="#impl-DowncastSync-for-T" title="DowncastSync">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Instrument-for-T" title="Instrument">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-MapEntities-for-T" title="MapEntities">MapEntities</a></li><li><a href="#impl-Receiver-for-P" title="Receiver">Receiver</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-T" title="VZip<V>">VZip<V></a></li><li><a href="#impl-VisitEntities-for-T" title="VisitEntities">VisitEntities</a></li><li><a href="#impl-VisitEntitiesMut-for-T" title="VisitEntitiesMut">VisitEntitiesMut</a></li><li><a href="#impl-WithSubscriber-for-T" title="WithSubscriber">WithSubscriber</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>ecs::<wbr>change_<wbr>detection</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_ecs</a>::<wbr><a href="index.html">change_detection</a></span><h1>Struct <span class="struct">ResMut</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_ecs/change_detection.rs.html#628-633">Source</a> </span></div><pre class="rust item-decl"><code>pub struct ResMut<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Unique mutable borrow of a <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a>.</p>
|
||
<p>See the <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a> documentation for usage.</p>
|
||
<p>If you need a shared borrow, use <a href="struct.Res.html" title="struct bevy_ecs::change_detection::Res"><code>Res</code></a> instead.</p>
|
||
<p>This <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a> fails validation if resource doesn’t exist.
|
||
/// This will cause a panic, but can be configured to do nothing or warn once.</p>
|
||
<p>Use <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option"><code>Option<ResMut<T>></code></a> instead if the resource might not always exist.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><a href="#impl-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'w mut T</a></h4></section></summary><div class="docblock"><p>Consume <code>self</code> and return a mutable reference to the
|
||
contained value while marking <code>self</code> as “changed”.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.reborrow" class="method"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><h4 class="code-header">pub fn <a href="#method.reborrow" class="fn">reborrow</a>(&mut self) -> <a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns a <code>Mut<></code> with a smaller lifetime.
|
||
This is useful if you have <code>&mut ResMut <T></code>, but you need a <code>Mut<T></code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_unchanged" class="method"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><h4 class="code-header">pub fn <a href="#method.map_unchanged" class="fn">map_unchanged</a><U: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
self,
|
||
f: impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut U</a>,
|
||
) -> <a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'w, U></h4></section></summary><div class="docblock"><p>Maps to an inner value by applying a function to the contained reference, without flagging a change.</p>
|
||
<p>You should never modify the argument passed to the closure – if you want to modify the data
|
||
without flagging a change, consider using <a href="trait.DetectChangesMut.html#tymethod.bypass_change_detection" title="method bevy_ecs::change_detection::DetectChangesMut::bypass_change_detection"><code>DetectChangesMut::bypass_change_detection</code></a> to make your intent explicit.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// When run, zeroes the translation of every entity.
|
||
</span><span class="kw">fn </span>reset_positions(<span class="kw-2">mut </span>transforms: Query<<span class="kw-2">&mut </span>Transform>) {
|
||
<span class="kw">for </span>transform <span class="kw">in </span><span class="kw-2">&mut </span>transforms {
|
||
<span class="comment">// We pinky promise not to modify `t` within the closure.
|
||
// Breaking this promise will result in logic errors, but will never cause undefined behavior.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>translation = transform.map_unchanged(|t| <span class="kw-2">&mut </span>t.translation);
|
||
<span class="comment">// Only reset the translation if it isn't already zero;
|
||
</span>translation.set_if_neq(Vec2::ZERO);
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.filter_map_unchanged" class="method"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><h4 class="code-header">pub fn <a href="#method.filter_map_unchanged" class="fn">filter_map_unchanged</a><U: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
self,
|
||
f: impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut U</a>>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'w, U>></h4></section></summary><div class="docblock"><p>Optionally maps to an inner value by applying a function to the contained reference.
|
||
This is useful in a situation where you need to convert a <code>Mut<T></code> to a <code>Mut<U></code>, but only if <code>T</code> contains <code>U</code>.</p>
|
||
<p>As with <code>map_unchanged</code>, you should never modify the argument passed to the closure.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_deref_mut" class="method"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#662">Source</a><h4 class="code-header">pub fn <a href="#method.as_deref_mut" class="fn">as_deref_mut</a>(&mut self) -> <a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'_, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a>,</div></h4></section></summary><div class="docblock"><p>Allows you access to the dereferenced value of this pointer without immediately
|
||
triggering change detection.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AsMut%3CT%3E-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#impl-AsMut%3CT%3E-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><T> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_mut" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#method.as_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.AsMut.html#tymethod.as_mut" class="fn">as_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Converts this type into a mutable reference of the (usually inferred) input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsRef%3CT%3E-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#impl-AsRef%3CT%3E-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><T> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_ref" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#method.as_ref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.AsRef.html#tymethod.as_ref" class="fn">as_ref</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Converts this type into a shared reference of the (usually inferred) input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#663">Source</a><a href="#impl-Debug-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#663">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#impl-Deref-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#impl-DerefMut-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#method.deref_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fn">deref_mut</a>(&mut self) -> &mut Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DetectChanges-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#impl-DetectChanges-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="trait.DetectChanges.html" title="trait bevy_ecs::change_detection::DetectChanges">DetectChanges</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.is_added" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#method.is_added" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChanges.html#tymethod.is_added" class="fn">is_added</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Returns <code>true</code> if this value was added after the system last ran.</div></details><details class="toggle method-toggle" open><summary><section id="method.is_changed" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#method.is_changed" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChanges.html#tymethod.is_changed" class="fn">is_changed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Returns <code>true</code> if this value was added or mutably dereferenced
|
||
either since the last time the system ran or, if the system never ran,
|
||
since the beginning of the program. <a href="trait.DetectChanges.html#tymethod.is_changed">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.last_changed" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#660">Source</a><a href="#method.last_changed" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChanges.html#tymethod.last_changed" class="fn">last_changed</a>(&self) -> <a class="struct" href="../component/struct.Tick.html" title="struct bevy_ecs::component::Tick">Tick</a></h4></section></summary><div class='docblock'>Returns the change tick recording the time this data was most recently changed. <a href="trait.DetectChanges.html#tymethod.last_changed">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DetectChangesMut-for-ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#impl-DetectChangesMut-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="trait.DetectChangesMut.html" title="trait bevy_ecs::change_detection::DetectChangesMut">DetectChangesMut</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Inner" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#associatedtype.Inner" class="anchor">§</a><h4 class="code-header">type <a href="trait.DetectChangesMut.html#associatedtype.Inner" class="associatedtype">Inner</a> = T</h4></section></summary><div class='docblock'>The type contained within this smart pointer <a href="trait.DetectChangesMut.html#associatedtype.Inner">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.set_changed" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#method.set_changed" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChangesMut.html#tymethod.set_changed" class="fn">set_changed</a>(&mut self)</h4></section></summary><div class='docblock'>Flags this value as having been changed. <a href="trait.DetectChangesMut.html#tymethod.set_changed">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.set_last_changed" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#method.set_last_changed" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChangesMut.html#tymethod.set_last_changed" class="fn">set_last_changed</a>(&mut self, last_changed: <a class="struct" href="../component/struct.Tick.html" title="struct bevy_ecs::component::Tick">Tick</a>)</h4></section></summary><div class='docblock'>Manually sets the change tick recording the time when this data was last mutated. <a href="trait.DetectChangesMut.html#tymethod.set_last_changed">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.bypass_change_detection" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#661">Source</a><a href="#method.bypass_change_detection" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChangesMut.html#tymethod.bypass_change_detection" class="fn">bypass_change_detection</a>(&mut self) -> &mut Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a></h4></section></summary><div class='docblock'>Manually bypasses change detection, allowing you to mutate the underlying value without updating the change tick. <a href="trait.DetectChangesMut.html#tymethod.bypass_change_detection">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.set_if_neq" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#181-193">Source</a><a href="#method.set_if_neq" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChangesMut.html#method.set_if_neq" class="fn">set_if_neq</a>(&mut self, value: Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a><div class="where">where
|
||
Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class='docblock'>Overwrites this smart pointer with the given value, if and only if <code>*self != value</code>.
|
||
Returns <code>true</code> if the value was overwritten, and returns <code>false</code> if it was not. <a href="trait.DetectChangesMut.html#method.set_if_neq">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.replace_if_neq" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#258-270">Source</a><a href="#method.replace_if_neq" class="anchor">§</a><h4 class="code-header">fn <a href="trait.DetectChangesMut.html#method.replace_if_neq" class="fn">replace_if_neq</a>(&mut self, value: Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a>><div class="where">where
|
||
Self::<a class="associatedtype" href="trait.DetectChangesMut.html#associatedtype.Inner" title="type bevy_ecs::change_detection::DetectChangesMut::Inner">Inner</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class='docblock'>Overwrites this smart pointer with the given value, if and only if <code>*self != value</code>,
|
||
returning the previous value if this occurs. <a href="trait.DetectChangesMut.html#method.replace_if_neq">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CResMut%3C'w,+T%3E%3E-for-Mut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#665-676">Source</a><a href="#impl-From%3CResMut%3C'w,+T%3E%3E-for-Mut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T>> for <a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#668-675">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(other: <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T>) -> <a class="struct" href="struct.Mut.html" title="struct bevy_ecs::change_detection::Mut">Mut</a><'w, T></h4></section></summary><div class="docblock"><p>Convert this <code>ResMut</code> into a <code>Mut</code>. This allows keeping the change-detection feature of <code>Mut</code>
|
||
while losing the specificity of <code>ResMut</code> for resources.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CResMut%3C'w,+T%3E%3E-for-Res%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#580-589">Source</a><a href="#impl-From%3CResMut%3C'w,+T%3E%3E-for-Res%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T>> for <a class="struct" href="struct.Res.html" title="struct bevy_ecs::change_detection::Res">Res</a><'w, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#581-588">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(res: <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#635-645">Source</a><a href="#impl-IntoIterator-for-%26ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, 'a, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a T</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#639">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a T</a> as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#640">Source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a T</a> as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#642-644">Source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26mut+ResMut%3C'w,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#647-658">Source</a><a href="#impl-IntoIterator-for-%26mut+ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, 'a, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut T</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#651">Source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut T</a> as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#652">Source</a><a href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut T</a> as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-1" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/change_detection.rs.html#654-657">Source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SystemParam-for-ResMut%3C'a,+T%3E" class="impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#855-929">Source</a><a href="#impl-SystemParam-for-ResMut%3C'a,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>> <a class="trait" href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam">SystemParam</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'a, T></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.State" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#856">Source</a><a href="#associatedtype.State" class="anchor">§</a><h4 class="code-header">type <a href="../system/trait.SystemParam.html#associatedtype.State" class="associatedtype">State</a> = <a class="struct" href="../component/struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class='docblock'>Used to store data which persists across invocations of a system.</div></details><details class="toggle" open><summary><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#857">Source</a><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a href="../system/trait.SystemParam.html#associatedtype.Item" class="associatedtype">Item</a><'w, 's> = <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h4></section></summary><div class='docblock'>The item type returned when constructing this system param.
|
||
The value of this associated type should be <code>Self</code>, instantiated with new lifetimes. <a href="../system/trait.SystemParam.html#associatedtype.Item">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.init_state" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#859-882">Source</a><a href="#method.init_state" class="anchor">§</a><h4 class="code-header">fn <a href="../system/trait.SystemParam.html#tymethod.init_state" class="fn">init_state</a>(world: &mut <a class="struct" href="../world/struct.World.html" title="struct bevy_ecs::world::World">World</a>, system_meta: &mut <a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>) -> Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a></h4></section></summary><div class='docblock'>Registers any <a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a> access used by this <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a>
|
||
and creates a new instance of this param’s <a href="../system/trait.SystemParam.html#associatedtype.State" title="associated type bevy_ecs::system::SystemParam::State"><code>State</code></a>.</div></details><details class="toggle method-toggle" open><summary><section id="method.validate_param" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#885-899">Source</a><a href="#method.validate_param" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../system/trait.SystemParam.html#method.validate_param" class="fn">validate_param</a>(
|
||
component_id: &Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a>,
|
||
system_meta: &<a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>,
|
||
world: <a class="struct" href="../world/unsafe_world_cell/struct.UnsafeWorldCell.html" title="struct bevy_ecs::world::unsafe_world_cell::UnsafeWorldCell">UnsafeWorldCell</a><'_>,
|
||
) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Validates that the param can be acquired by the <a href="../system/trait.SystemParam.html#tymethod.get_param" title="associated function bevy_ecs::system::SystemParam::get_param"><code>get_param</code></a>.
|
||
Built-in executors use this to prevent systems with invalid params from running.
|
||
For nested <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a>s validation will fail if any
|
||
delegated validation fails. <a href="../system/trait.SystemParam.html#method.validate_param">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.get_param" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#902-928">Source</a><a href="#method.get_param" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../system/trait.SystemParam.html#tymethod.get_param" class="fn">get_param</a><'w, 's>(
|
||
component_id: &'s mut Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a>,
|
||
system_meta: &<a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>,
|
||
world: <a class="struct" href="../world/unsafe_world_cell/struct.UnsafeWorldCell.html" title="struct bevy_ecs::world::unsafe_world_cell::UnsafeWorldCell">UnsafeWorldCell</a><'w>,
|
||
change_tick: <a class="struct" href="../component/struct.Tick.html" title="struct bevy_ecs::component::Tick">Tick</a>,
|
||
) -> Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.Item" title="type bevy_ecs::system::SystemParam::Item">Item</a><'w, 's></h4></section></summary><div class='docblock'>Creates a parameter to be passed into a <a href="../system/trait.SystemParamFunction.html" title="trait bevy_ecs::system::SystemParamFunction"><code>SystemParamFunction</code></a>. <a href="../system/trait.SystemParam.html#tymethod.get_param">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.new_archetype" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#203-208">Source</a><a href="#method.new_archetype" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../system/trait.SystemParam.html#method.new_archetype" class="fn">new_archetype</a>(
|
||
state: &mut Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a>,
|
||
archetype: &<a class="struct" href="../archetype/struct.Archetype.html" title="struct bevy_ecs::archetype::Archetype">Archetype</a>,
|
||
system_meta: &mut <a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>,
|
||
)</h4></section></summary><div class='docblock'>For the specified <a href="../archetype/struct.Archetype.html" title="struct bevy_ecs::archetype::Archetype"><code>Archetype</code></a>, registers the components accessed by this <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a> (if applicable).a <a href="../system/trait.SystemParam.html#method.new_archetype">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.apply" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#216">Source</a><a href="#method.apply" class="anchor">§</a><h4 class="code-header">fn <a href="../system/trait.SystemParam.html#method.apply" class="fn">apply</a>(state: &mut Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a>, system_meta: &<a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>, world: &mut <a class="struct" href="../world/struct.World.html" title="struct bevy_ecs::world::World">World</a>)</h4></section></summary><div class='docblock'>Applies any deferred mutations stored in this <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a>’s state.
|
||
This is used to apply <a href="../system/struct.Commands.html" title="struct bevy_ecs::system::Commands"><code>Commands</code></a> during <a href="../schedule/fn.apply_deferred.html" title="fn bevy_ecs::schedule::apply_deferred"><code>apply_deferred</code></a>.</div></details><details class="toggle method-toggle" open><summary><section id="method.queue" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#221">Source</a><a href="#method.queue" class="anchor">§</a><h4 class="code-header">fn <a href="../system/trait.SystemParam.html#method.queue" class="fn">queue</a>(
|
||
state: &mut Self::<a class="associatedtype" href="../system/trait.SystemParam.html#associatedtype.State" title="type bevy_ecs::system::SystemParam::State">State</a>,
|
||
system_meta: &<a class="struct" href="../system/struct.SystemMeta.html" title="struct bevy_ecs::system::SystemMeta">SystemMeta</a>,
|
||
world: <a class="struct" href="../world/struct.DeferredWorld.html" title="struct bevy_ecs::world::DeferredWorld">DeferredWorld</a><'_>,
|
||
)</h4></section></summary><div class='docblock'>Queues any deferred mutations to be applied at the next <a href="../schedule/fn.apply_deferred.html" title="fn bevy_ecs::schedule::apply_deferred"><code>apply_deferred</code></a>.</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-Freeze-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-Send-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-Send-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-Sync-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-Sync-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-Unpin-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-Unpin-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T><div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section><section id="impl-UnwindSafe-for-ResMut%3C'w,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-ResMut%3C'w,+T%3E" class="anchor">§</a><h3 class="code-header">impl<'w, T> !<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ResMut.html" title="struct bevy_ecs::change_detection::ResMut">ResMut</a><'w, T></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Downcast-for-T" class="impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#189">Source</a><a href="#impl-Downcast-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_any" class="method trait-impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#190">Source</a><a href="#method.into_any" class="anchor">§</a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any" class="fn">into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a>></h4></section></summary><div class='docblock'>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can
|
||
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.into_any_rc" class="method trait-impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#191">Source</a><a href="#method.into_any_rc" class="anchor">§</a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc" class="fn">into_any_rc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a>></h4></section></summary><div class='docblock'>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.as_any" class="method trait-impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#192">Source</a><a href="#method.as_any" class="anchor">§</a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any" class="fn">as_any</a>(&self) -> &(dyn <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></section></summary><div class='docblock'>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&Any</code>’s vtable from <code>&Trait</code>’s.</div></details><details class="toggle method-toggle" open><summary><section id="method.as_any_mut" class="method trait-impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#193">Source</a><a href="#method.as_any_mut" class="anchor">§</a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut" class="fn">as_any_mut</a>(&mut self) -> &mut (dyn <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></section></summary><div class='docblock'>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&mut Any</code>’s vtable from <code>&mut Trait</code>’s.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-DowncastSync-for-T" class="impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#203">Source</a><a href="#impl-DowncastSync-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../downcast_rs/trait.DowncastSync.html" title="trait downcast_rs::DowncastSync">DowncastSync</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_any_arc" class="method trait-impl"><a class="src rightside" href="../../src/downcast_rs/lib.rs.html#204">Source</a><a href="#method.into_any_arc" class="anchor">§</a><h4 class="code-header">fn <a href="../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc" class="fn">into_any_arc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>></h4></section></summary><div class='docblock'>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-T" class="impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#325">Source</a><a href="#impl-Instrument-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#86">Source</a><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fn">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#128">Source</a><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fn">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="../../tracing/span/struct.Span.html#method.current" title="associated function tracing::span::Span::current">current</a> <a href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span"><code>Span</code></a>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MapEntities-for-T" class="impl"><a class="src rightside" href="../../src/bevy_ecs/entity/map_entities.rs.html#55-61">Source</a><a href="#impl-MapEntities-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../entity/trait.MapEntities.html" title="trait bevy_ecs::entity::MapEntities">MapEntities</a> for T<div class="where">where
|
||
T: <a class="trait" href="../entity/trait.VisitEntitiesMut.html" title="trait bevy_ecs::entity::VisitEntitiesMut">VisitEntitiesMut</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.map_entities" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/entity/map_entities.rs.html#56-60">Source</a><a href="#method.map_entities" class="anchor">§</a><h4 class="code-header">fn <a href="../entity/trait.MapEntities.html#tymethod.map_entities" class="fn">map_entities</a><M>(&mut self, entity_mapper: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut M</a>)<div class="where">where
|
||
M: <a class="trait" href="../entity/trait.EntityMapper.html" title="trait bevy_ecs::entity::EntityMapper">EntityMapper</a>,</div></h4></section></summary><div class='docblock'>Updates all <a href="../entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity"><code>Entity</code></a> references stored inside using <code>entity_mapper</code>. <a href="../entity/trait.MapEntities.html#tymethod.map_entities">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Receiver-for-P" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/ops/deref.rs.html#374-376">Source</a><a href="#impl-Receiver-for-P" class="anchor">§</a><h3 class="code-header">impl<P, T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Receiver.html" title="trait core::ops::deref::Receiver">Receiver</a> for P<div class="where">where
|
||
P: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = T> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/ops/deref.rs.html#378">Source</a><a href="#associatedtype.Target-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/deref/trait.Receiver.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>arbitrary_self_types</code>)</span></div></span><div class='docblock'>The target type on which the method may be called.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-T" class="impl"><a class="src rightside" href="../../src/ppv_lite86/types.rs.html#221-223">Source</a><a href="#impl-VZip%3CV%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<V, T> <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<div class="where">where
|
||
V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</div></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl"><a class="src rightside" href="../../src/ppv_lite86/types.rs.html#226">Source</a><a href="#method.vzip" class="anchor">§</a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fn">vzip</a>(self) -> V</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VisitEntities-for-T" class="impl"><a class="src rightside" href="../../src/bevy_ecs/entity/visit_entities.rs.html#16-23">Source</a><a href="#impl-VisitEntities-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../entity/trait.VisitEntities.html" title="trait bevy_ecs::entity::VisitEntities">VisitEntities</a> for T<div class="where">where
|
||
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a T</a>: for<'a> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = &'a <a class="struct" href="../entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity">Entity</a>>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.visit_entities" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/entity/visit_entities.rs.html#20-22">Source</a><a href="#method.visit_entities" class="anchor">§</a><h4 class="code-header">fn <a href="../entity/trait.VisitEntities.html#tymethod.visit_entities" class="fn">visit_entities</a><F>(&self, f: F)<div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity">Entity</a>),</div></h4></section></summary><div class='docblock'>Apply an operation to all contained entities.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VisitEntitiesMut-for-T" class="impl"><a class="src rightside" href="../../src/bevy_ecs/entity/visit_entities.rs.html#42-49">Source</a><a href="#impl-VisitEntitiesMut-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../entity/trait.VisitEntitiesMut.html" title="trait bevy_ecs::entity::VisitEntitiesMut">VisitEntitiesMut</a> for T<div class="where">where
|
||
T: <a class="trait" href="../entity/trait.VisitEntities.html" title="trait bevy_ecs::entity::VisitEntities">VisitEntities</a>,
|
||
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut T</a>: for<'a> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = &'a mut <a class="struct" href="../entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity">Entity</a>>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.visit_entities_mut" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/entity/visit_entities.rs.html#46-48">Source</a><a href="#method.visit_entities_mut" class="anchor">§</a><h4 class="code-header">fn <a href="../entity/trait.VisitEntitiesMut.html#tymethod.visit_entities_mut" class="fn">visit_entities_mut</a><F>(&mut self, f: F)<div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut <a class="struct" href="../entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity">Entity</a>),</div></h4></section></summary><div class='docblock'>Apply an operation to mutable references to all contained entities.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-T" class="impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#393">Source</a><a href="#impl-WithSubscriber-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#176-178">Source</a><a href="#method.with_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fn">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</div></h4></section></summary><div class='docblock'>Attaches the provided <a href="../../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
<a href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl"><a class="src rightside" href="../../src/tracing/instrument.rs.html#228">Source</a><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fn">with_current_subscriber</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'>Attaches the current <a href="../../tracing/dispatcher/index.html#setting-the-default-subscriber" title="mod tracing::dispatcher">default</a> <a href="../../tracing_core/subscriber/trait.Subscriber.html" title="trait tracing_core::subscriber::Subscriber"><code>Subscriber</code></a> to this type, returning a
|
||
<a href="../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details><section id="impl-ConditionalSend-for-T" class="impl"><a class="src rightside" href="../../src/bevy_utils/lib.rs.html#65">Source</a><a href="#impl-ConditionalSend-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../../bevy_utils/conditional_send/trait.ConditionalSend.html" title="trait bevy_utils::conditional_send::ConditionalSend">ConditionalSend</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section></div></section></div></main></body></html> |