37 lines
4.6 KiB
HTML
37 lines
4.6 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="Macro to define a new label trait"><title>define_label in bevy_ecs - 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 macro"><!--[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="#">define_<wbr>label</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bevy_<wbr>ecs</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></span><h1>Macro <span class="macro">define_label</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/label.rs.html#94-203">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! define_label {
|
|
(
|
|
$(#[$label_attr:meta])*
|
|
$label_trait_name:ident,
|
|
$interner_name:ident
|
|
) => { ... };
|
|
(
|
|
$(#[$label_attr:meta])*
|
|
$label_trait_name:ident,
|
|
$interner_name:ident,
|
|
extra_methods: { $($trait_extra_methods:tt)* },
|
|
extra_methods_impl: { $($interned_extra_methods_impl:tt)* }
|
|
) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Macro to define a new label trait</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">define_label!</span>(
|
|
<span class="doccomment">/// Documentation of label trait
|
|
</span>MyNewLabelTrait,
|
|
MY_NEW_LABEL_TRAIT_INTERNER
|
|
);
|
|
|
|
<span class="macro">define_label!</span>(
|
|
<span class="doccomment">/// Documentation of another label trait
|
|
</span>MyNewExtendedLabelTrait,
|
|
MY_NEW_EXTENDED_LABEL_TRAIT_INTERNER,
|
|
extra_methods: {
|
|
<span class="comment">// Extra methods for the trait can be defined here
|
|
</span><span class="kw">fn </span>additional_method(<span class="kw-2">&</span><span class="self">self</span>) -> i32;
|
|
},
|
|
extra_methods_impl: {
|
|
<span class="comment">// Implementation of the extra methods for Interned<dyn MyNewExtendedLabelTrait>
|
|
</span><span class="kw">fn </span>additional_method(<span class="kw-2">&</span><span class="self">self</span>) -> i32 {
|
|
<span class="number">0
|
|
</span>}
|
|
}
|
|
);</code></pre></div>
|
|
</div></details></section></div></main></body></html> |