152 lines
65 KiB
HTML
152 lines
65 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="Stores metadata associated with each kind of `Component` in a given `World`."><title>Components in bevy_ecs::component - 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="#">Components</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.component_id" title="component_id">component_id</a></li><li><a href="#method.get_id" title="get_id">get_id</a></li><li><a href="#method.get_info" title="get_info">get_info</a></li><li><a href="#method.get_info_unchecked" title="get_info_unchecked">get_info_unchecked</a></li><li><a href="#method.get_name" title="get_name">get_name</a></li><li><a href="#method.get_resource_id" title="get_resource_id">get_resource_id</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.iter" title="iter">iter</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.register_component" title="register_component">register_component</a></li><li><a href="#method.register_component_with_descriptor" title="register_component_with_descriptor">register_component_with_descriptor</a></li><li><a href="#method.register_non_send" title="register_non_send">register_non_send</a></li><li><a href="#method.register_resource" title="register_resource">register_resource</a></li><li><a href="#method.register_resource_with_descriptor" title="register_resource_with_descriptor">register_resource_with_descriptor</a></li><li><a href="#method.resource_id" title="resource_id">resource_id</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Components" title="Debug">Debug</a></li><li><a href="#impl-Default-for-Components" title="Default">Default</a></li><li><a href="#impl-ReadOnlySystemParam-for-%26Components" title="ReadOnlySystemParam">ReadOnlySystemParam</a></li><li><a href="#impl-SystemParam-for-%26Components" 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-RefUnwindSafe-for-Components" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Components" title="!Send">!Send</a></li><li><a href="#impl-Sync-for-Components" title="!Sync">!Sync</a></li><li><a href="#impl-UnwindSafe-for-Components" title="!UnwindSafe">!UnwindSafe</a></li><li><a href="#impl-Freeze-for-Components" title="Freeze">Freeze</a></li><li><a href="#impl-Unpin-for-Components" 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-Downcast-for-T" title="Downcast">Downcast</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-FromWorld-for-T" title="FromWorld">FromWorld</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-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-WithSubscriber-for-T" title="WithSubscriber">WithSubscriber</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>ecs::<wbr>component</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">component</a></span><h1>Struct <span class="struct">Components</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/component.rs.html#880-884">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Components { <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>Stores metadata associated with each kind of <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> in a given <a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a>.</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-Components" class="impl"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#886-1433">Source</a><a href="#impl-Components" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.register_component" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#896-923">Source</a><h4 class="code-header">pub fn <a href="#method.register_component" class="fn">register_component</a><T: <a class="trait" href="trait.Component.html" title="trait bevy_ecs::component::Component">Component</a>>(
|
||
&mut self,
|
||
storages: &mut <a class="struct" href="../storage/struct.Storages.html" title="struct bevy_ecs::storage::Storages">Storages</a>,
|
||
) -> <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class="docblock"><p>Registers a <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> of type <code>T</code> with this instance.
|
||
If a component of this type has already been registered, this will return
|
||
the ID of the pre-existing component.</p>
|
||
<h5 id="see-also"><a class="doc-anchor" href="#see-also">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.component_id" title="method bevy_ecs::component::Components::component_id"><code>Components::component_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.register_component_with_descriptor" title="method bevy_ecs::component::Components::register_component_with_descriptor"><code>Components::register_component_with_descriptor()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.register_component_with_descriptor" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#936-942">Source</a><h4 class="code-header">pub fn <a href="#method.register_component_with_descriptor" class="fn">register_component_with_descriptor</a>(
|
||
&mut self,
|
||
storages: &mut <a class="struct" href="../storage/struct.Storages.html" title="struct bevy_ecs::storage::Storages">Storages</a>,
|
||
descriptor: <a class="struct" href="struct.ComponentDescriptor.html" title="struct bevy_ecs::component::ComponentDescriptor">ComponentDescriptor</a>,
|
||
) -> <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class="docblock"><p>Registers a component described by <code>descriptor</code>.</p>
|
||
<h5 id="note"><a class="doc-anchor" href="#note">§</a>Note</h5>
|
||
<p>If this method is called multiple times with identical descriptors, a distinct <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a>
|
||
will be created for each one.</p>
|
||
<h5 id="see-also-1"><a class="doc-anchor" href="#see-also-1">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.component_id" title="method bevy_ecs::component::Components::component_id"><code>Components::component_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.register_component" title="method bevy_ecs::component::Components::register_component"><code>Components::register_component()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#961-963">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of components registered with this instance.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#967-969">Source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</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"><p>Returns <code>true</code> if there are no components registered with this instance. Otherwise, this returns <code>false</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_info" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#975-977">Source</a><h4 class="code-header">pub fn <a href="#method.get_info" class="fn">get_info</a>(&self, id: <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</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.ComponentInfo.html" title="struct bevy_ecs::component::ComponentInfo">ComponentInfo</a>></h4></section></summary><div class="docblock"><p>Gets the metadata associated with the given component.</p>
|
||
<p>This will return an incorrect result if <code>id</code> did not come from the same world as <code>self</code>. It may return <code>None</code> or a garbage value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_name" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#983-985">Source</a><h4 class="code-header">pub fn <a href="#method.get_name" class="fn">get_name</a>(&self, id: <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</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.str.html">str</a>></h4></section></summary><div class="docblock"><p>Returns the name associated with the given component.</p>
|
||
<p>This will return an incorrect result if <code>id</code> did not come from the same world as <code>self</code>. It may return <code>None</code> or a garbage value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_info_unchecked" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#992-996">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_info_unchecked" class="fn">get_info_unchecked</a>(&self, id: <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a>) -> &<a class="struct" href="struct.ComponentInfo.html" title="struct bevy_ecs::component::ComponentInfo">ComponentInfo</a></h4></section></summary><div class="docblock"><p>Gets the metadata associated with the given component.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p><code>id</code> must be a valid <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_id" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1281-1283">Source</a><h4 class="code-header">pub fn <a href="#method.get_id" class="fn">get_id</a>(&self, type_id: <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</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.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a>></h4></section></summary><div class="docblock"><p>Type-erased equivalent of <a href="struct.Components.html#method.component_id" title="method bevy_ecs::component::Components::component_id"><code>Components::component_id()</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.component_id" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1313-1315">Source</a><h4 class="code-header">pub fn <a href="#method.component_id" class="fn">component_id</a><T: <a class="trait" href="trait.Component.html" title="trait bevy_ecs::component::Component">Component</a>>(&self) -> <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.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a>></h4></section></summary><div class="docblock"><p>Returns the <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a> of the given <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> type <code>T</code>.</p>
|
||
<p>The returned <code>ComponentId</code> is specific to the <code>Components</code> instance
|
||
it was retrieved from and should not be used with another <code>Components</code>
|
||
instance.</p>
|
||
<p>Returns <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> if the <code>Component</code> type has not
|
||
yet been initialized using <a href="struct.Components.html#method.register_component" title="method bevy_ecs::component::Components::register_component"><code>Components::register_component()</code></a>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bevy_ecs::prelude::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>world = World::new();
|
||
|
||
<span class="attr">#[derive(Component)]
|
||
</span><span class="kw">struct </span>ComponentA;
|
||
|
||
<span class="kw">let </span>component_a_id = world.register_component::<ComponentA>();
|
||
|
||
<span class="macro">assert_eq!</span>(component_a_id, world.components().component_id::<ComponentA>().unwrap())</code></pre></div>
|
||
<h5 id="see-also-2"><a class="doc-anchor" href="#see-also-2">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.get_id" title="method bevy_ecs::component::Components::get_id"><code>Components::get_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.resource_id" title="method bevy_ecs::component::Components::resource_id"><code>Components::resource_id()</code></a></li>
|
||
<li><a href="../world/struct.World.html#method.component_id" title="method bevy_ecs::world::World::component_id"><code>World::component_id()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_resource_id" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1319-1321">Source</a><h4 class="code-header">pub fn <a href="#method.get_resource_id" class="fn">get_resource_id</a>(&self, type_id: <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</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.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a>></h4></section></summary><div class="docblock"><p>Type-erased equivalent of <a href="struct.Components.html#method.resource_id" title="method bevy_ecs::component::Components::resource_id"><code>Components::resource_id()</code></a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.resource_id" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1350-1352">Source</a><h4 class="code-header">pub fn <a href="#method.resource_id" class="fn">resource_id</a><T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>>(&self) -> <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.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a>></h4></section></summary><div class="docblock"><p>Returns the <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a> of the given <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a> type <code>T</code>.</p>
|
||
<p>The returned <code>ComponentId</code> is specific to the <code>Components</code> instance
|
||
it was retrieved from and should not be used with another <code>Components</code>
|
||
instance.</p>
|
||
<p>Returns <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> if the <code>Resource</code> type has not
|
||
yet been initialized using <a href="struct.Components.html#method.register_resource" title="method bevy_ecs::component::Components::register_resource"><code>Components::register_resource()</code></a>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bevy_ecs::prelude::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>world = World::new();
|
||
|
||
<span class="attr">#[derive(Resource, Default)]
|
||
</span><span class="kw">struct </span>ResourceA;
|
||
|
||
<span class="kw">let </span>resource_a_id = world.init_resource::<ResourceA>();
|
||
|
||
<span class="macro">assert_eq!</span>(resource_a_id, world.components().resource_id::<ResourceA>().unwrap())</code></pre></div>
|
||
<h5 id="see-also-3"><a class="doc-anchor" href="#see-also-3">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.component_id" title="method bevy_ecs::component::Components::component_id"><code>Components::component_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.get_resource_id" title="method bevy_ecs::component::Components::get_resource_id"><code>Components::get_resource_id()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.register_resource" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1363-1370">Source</a><h4 class="code-header">pub fn <a href="#method.register_resource" class="fn">register_resource</a><T: <a class="trait" href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource">Resource</a>>(&mut self) -> <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class="docblock"><p>Registers a <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a> of type <code>T</code> with this instance.
|
||
If a resource of this type has already been registered, this will return
|
||
the ID of the pre-existing resource.</p>
|
||
<h5 id="see-also-4"><a class="doc-anchor" href="#see-also-4">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.resource_id" title="method bevy_ecs::component::Components::resource_id"><code>Components::resource_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.register_resource_with_descriptor" title="method bevy_ecs::component::Components::register_resource_with_descriptor"><code>Components::register_resource_with_descriptor()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.register_resource_with_descriptor" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1383-1388">Source</a><h4 class="code-header">pub fn <a href="#method.register_resource_with_descriptor" class="fn">register_resource_with_descriptor</a>(
|
||
&mut self,
|
||
descriptor: <a class="struct" href="struct.ComponentDescriptor.html" title="struct bevy_ecs::component::ComponentDescriptor">ComponentDescriptor</a>,
|
||
) -> <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class="docblock"><p>Registers a <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a> described by <code>descriptor</code>.</p>
|
||
<h5 id="note-1"><a class="doc-anchor" href="#note-1">§</a>Note</h5>
|
||
<p>If this method is called multiple times with identical descriptors, a distinct <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a>
|
||
will be created for each one.</p>
|
||
<h5 id="see-also-5"><a class="doc-anchor" href="#see-also-5">§</a>See also</h5>
|
||
<ul>
|
||
<li><a href="struct.Components.html#method.resource_id" title="method bevy_ecs::component::Components::resource_id"><code>Components::resource_id()</code></a></li>
|
||
<li><a href="struct.Components.html#method.register_resource" title="method bevy_ecs::component::Components::register_resource"><code>Components::register_resource()</code></a></li>
|
||
</ul>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.register_non_send" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1394-1401">Source</a><h4 class="code-header">pub fn <a href="#method.register_non_send" class="fn">register_non_send</a><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>>(&mut self) -> <a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">ComponentId</a></h4></section></summary><div class="docblock"><p>Registers a <a href="../system/struct.NonSend.html" title="struct bevy_ecs::system::NonSend">non-send resource</a> of type <code>T</code> with this instance.
|
||
If a resource of this type has already been registered, this will return
|
||
the ID of the pre-existing resource.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#1430-1432">Source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = &<a class="struct" href="struct.ComponentInfo.html" title="struct bevy_ecs::component::ComponentInfo">ComponentInfo</a>> + '_</h4></section></summary><div class="docblock"><p>Gets an iterator over all components registered with this instance.</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-Debug-for-Components" class="impl"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#879">Source</a><a href="#impl-Debug-for-Components" class="anchor">§</a><h3 class="code-header">impl <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.Components.html" title="struct bevy_ecs::component::Components">Components</a></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/component.rs.html#879">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-Default-for-Components" class="impl"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#879">Source</a><a href="#impl-Default-for-Components" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/component.rs.html#879">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SystemParam-for-%26Components" class="impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#1639-1654">Source</a><a href="#impl-SystemParam-for-%26Components" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam">SystemParam</a> for &'a <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></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#1640">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="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</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" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#1641">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="../system/trait.SystemParam.html#associatedtype.Item" class="associatedtype">Item</a><'w, 's> = &'w <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></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#1643">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.get_param" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#1646-1653">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>(
|
||
_state: &'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="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><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#250-258">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>(
|
||
_state: &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></div></details><section id="impl-ReadOnlySystemParam-for-%26Components" class="impl"><a class="src rightside" href="../../src/bevy_ecs/system/system_param.rs.html#1636">Source</a><a href="#impl-ReadOnlySystemParam-for-%26Components" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="../system/trait.ReadOnlySystemParam.html" title="trait bevy_ecs::system::ReadOnlySystemParam">ReadOnlySystemParam</a> for &'a <a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section></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-Components" class="impl"><a href="#impl-Freeze-for-Components" class="anchor">§</a><h3 class="code-header">impl <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.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section><section id="impl-RefUnwindSafe-for-Components" class="impl"><a href="#impl-RefUnwindSafe-for-Components" class="anchor">§</a><h3 class="code-header">impl !<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.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section><section id="impl-Send-for-Components" class="impl"><a href="#impl-Send-for-Components" class="anchor">§</a><h3 class="code-header">impl !<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.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section><section id="impl-Sync-for-Components" class="impl"><a href="#impl-Sync-for-Components" class="anchor">§</a><h3 class="code-header">impl !<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.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section><section id="impl-Unpin-for-Components" class="impl"><a href="#impl-Unpin-for-Components" class="anchor">§</a><h3 class="code-header">impl <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.Components.html" title="struct bevy_ecs::component::Components">Components</a></h3></section><section id="impl-UnwindSafe-for-Components" class="impl"><a href="#impl-UnwindSafe-for-Components" class="anchor">§</a><h3 class="code-header">impl !<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.Components.html" title="struct bevy_ecs::component::Components">Components</a></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-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" 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" 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-FromWorld-for-T" class="impl"><a class="src rightside" href="../../src/bevy_ecs/world/mod.rs.html#3782-3787">Source</a><a href="#impl-FromWorld-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../world/trait.FromWorld.html" title="trait bevy_ecs::world::FromWorld">FromWorld</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_world" class="method trait-impl"><a class="src rightside" href="../../src/bevy_ecs/world/mod.rs.html#3784-3786">Source</a><a href="#method.from_world" class="anchor">§</a><h4 class="code-header">fn <a href="../world/trait.FromWorld.html#tymethod.from_world" class="fn">from_world</a>(_world: &mut <a class="struct" href="../world/struct.World.html" title="struct bevy_ecs::world::World">World</a>) -> T</h4></section></summary><div class="docblock"><p>Creates <code>Self</code> using <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default" title="associated function core::default::Default::default"><code>default()</code></a>.</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-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-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></div></section></div></main></body></html> |