Files
phy/bevy_utils/trait.PreHashMapExt.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

16 lines
7.0 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="Extension methods intended to add functionality to `PreHashMap`."><title>PreHashMapExt in bevy_utils - 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_utils" 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 trait"><!--[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_utils/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_utils/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_utils/index.html">bevy_<wbr>utils</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">PreHash<wbr>MapExt</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_or_insert_with" title="get_or_insert_with">get_or_insert_with</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bevy_<wbr>utils</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_utils</a></span><h1>Trait <span class="trait">PreHashMapExt</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_utils/lib.rs.html#270-275">Source</a> </span></div><pre class="rust item-decl"><code>pub trait PreHashMapExt&lt;K, V&gt; {
// Required method
fn <a href="#tymethod.get_or_insert_with" class="fn">get_or_insert_with</a>&lt;F: <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>() -&gt; V&gt;(
&amp;mut self,
key: &amp;<a class="struct" href="struct.Hashed.html" title="struct bevy_utils::Hashed">Hashed</a>&lt;K&gt;,
func: F,
) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut V</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension methods intended to add functionality to <a href="type.PreHashMap.html" title="type bevy_utils::PreHashMap"><code>PreHashMap</code></a>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.get_or_insert_with" class="method"><a class="src rightside" href="../src/bevy_utils/lib.rs.html#274">Source</a><h4 class="code-header">fn <a href="#tymethod.get_or_insert_with" class="fn">get_or_insert_with</a>&lt;F: <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>() -&gt; V&gt;(
&amp;mut self,
key: &amp;<a class="struct" href="struct.Hashed.html" title="struct bevy_utils::Hashed">Hashed</a>&lt;K&gt;,
func: F,
) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut V</a></h4></section></summary><div class="docblock"><p>Tries to get or insert the value for the given <code>key</code> using the pre-computed hash first.
If the <a href="type.PreHashMap.html" title="type bevy_utils::PreHashMap"><code>PreHashMap</code></a> does not already contain the <code>key</code>, it will clone it and insert
the value returned by <code>func</code>.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-PreHashMapExt%3CK,+V%3E-for-HashMap%3CHashed%3CK%3E,+V,+PassHash%3E" class="impl"><a class="src rightside" href="../src/bevy_utils/lib.rs.html#277-291">Source</a><a href="#impl-PreHashMapExt%3CK,+V%3E-for-HashMap%3CHashed%3CK%3E,+V,+PassHash%3E" class="anchor">§</a><h3 class="code-header">impl&lt;K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</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> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, V&gt; <a class="trait" href="trait.PreHashMapExt.html" title="trait bevy_utils::PreHashMapExt">PreHashMapExt</a>&lt;K, V&gt; for <a class="type" href="type.PreHashMap.html" title="type bevy_utils::PreHashMap">PreHashMap</a>&lt;K, V&gt;</h3></section></div><script src="../trait.impl/bevy_utils/trait.PreHashMapExt.js" async></script></section></div></main></body></html>