rtic/dev/api/indexmap/map/raw_entry_v1/index.html
2024-12-06 13:35:18 +00:00

12 lines
No EOL
6.8 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="Opt-in access to the experimental raw entry API."><title>indexmap::map::raw_entry_v1 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="indexmap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../indexmap/index.html">indexmap</a><span class="version">2.7.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module raw_<wbr>entry_<wbr>v1</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In indexmap::<wbr>map</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">indexmap</a>::<wbr><a href="../index.html">map</a></span><h1>Module <span>raw_entry_v1</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/indexmap/map/core/raw_entry_v1.rs.html#1-665">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Opt-in access to the experimental raw entry API.</p>
<p>This module is designed to mimic the raw entry API of <a href="https://doc.rust-lang.org/1.83.0/std/collections/hash_map/index.html" title="mod std::collections::hash_map"><code>HashMap</code></a>,
matching its unstable state as of Rust 1.75. See the tracking issue
<a href="https://github.com/rust-lang/rust/issues/56167">rust#56167</a> for more details.</p>
<p>The trait <a href="trait.RawEntryApiV1.html" title="trait indexmap::map::raw_entry_v1::RawEntryApiV1"><code>RawEntryApiV1</code></a> and the <code>_v1</code> suffix on its methods are meant to insulate this for
the future, in case later breaking changes are needed. If the standard library stabilizes its
<code>hash_raw_entry</code> feature (or some replacement), matching <em>inherent</em> methods will be added to
<code>IndexMap</code> without such an opt-in trait.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.RawEntryBuilder.html" title="struct indexmap::map::raw_entry_v1::RawEntryBuilder">RawEntry<wbr>Builder</a></div><div class="desc docblock-short">A builder for computing where in an <a href="../struct.IndexMap.html" title="struct indexmap::map::IndexMap"><code>IndexMap</code></a> a key-value pair would be stored.</div></li><li><div class="item-name"><a class="struct" href="struct.RawEntryBuilderMut.html" title="struct indexmap::map::raw_entry_v1::RawEntryBuilderMut">RawEntry<wbr>Builder<wbr>Mut</a></div><div class="desc docblock-short">A builder for computing where in an <a href="../struct.IndexMap.html" title="struct indexmap::map::IndexMap"><code>IndexMap</code></a> a key-value pair would be stored.</div></li><li><div class="item-name"><a class="struct" href="struct.RawOccupiedEntryMut.html" title="struct indexmap::map::raw_entry_v1::RawOccupiedEntryMut">RawOccupied<wbr>Entry<wbr>Mut</a></div><div class="desc docblock-short">A raw view into an occupied entry in an <a href="../struct.IndexMap.html" title="struct indexmap::map::IndexMap"><code>IndexMap</code></a>.
It is part of the <a href="enum.RawEntryMut.html" title="enum indexmap::map::raw_entry_v1::RawEntryMut"><code>RawEntryMut</code></a> enum.</div></li><li><div class="item-name"><a class="struct" href="struct.RawVacantEntryMut.html" title="struct indexmap::map::raw_entry_v1::RawVacantEntryMut">RawVacant<wbr>Entry<wbr>Mut</a></div><div class="desc docblock-short">A view into a vacant raw entry in an <a href="../struct.IndexMap.html" title="struct indexmap::map::IndexMap"><code>IndexMap</code></a>.
It is part of the <a href="enum.RawEntryMut.html" title="enum indexmap::map::raw_entry_v1::RawEntryMut"><code>RawEntryMut</code></a> enum.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.RawEntryMut.html" title="enum indexmap::map::raw_entry_v1::RawEntryMut">RawEntry<wbr>Mut</a></div><div class="desc docblock-short">Raw entry for an existing key-value pair or a vacant location to
insert one.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.RawEntryApiV1.html" title="trait indexmap::map::raw_entry_v1::RawEntryApiV1">RawEntry<wbr>ApiV1</a></div><div class="desc docblock-short">Opt-in access to the experimental raw entry API.</div></li></ul></section></div></main></body></html>