rust-analyzer/stdx/anymap/index.html
github-merge-queue[bot] 1cb4edc731 deploy: 07b68bd9c1
2025-09-09 19:03:51 +00:00

16 lines
No EOL
6.8 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="This file is a port of only the necessary features from https://github.com/chris-morgan/anymap version 1.0.0-beta.2 for use within rust-analyzer."><title>stdx::anymap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="stdx" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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="../../stdx/index.html">stdx</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module anymap</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#cargo-features" title="Cargo features">Cargo features</a></li></ul><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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate stdx</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">stdx</a></div><h1>Module <span>anymap</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/stdx/anymap.rs.html#1-293">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This file is a port of only the necessary features from <a href="https://github.com/chris-morgan/anymap">https://github.com/chris-morgan/anymap</a> version 1.0.0-beta.2 for use within rust-analyzer.</p>
<p>Copyright © 20142022 Chris Morgan.
COPYING: <a href="https://github.com/chris-morgan/anymap/blob/master/COPYING">https://github.com/chris-morgan/anymap/blob/master/COPYING</a>
Note that the license is changed from Blue Oak Model 1.0.0 or MIT or Apache-2.0 to MIT OR Apache-2.0</p>
<p>This implementation provides a safe and convenient store for one value of each type.</p>
<p>Your starting point is <a href="struct.Map.html" title="struct stdx::anymap::Map"><code>Map</code></a>. It has an example.</p>
<h2 id="cargo-features"><a class="doc-anchor" href="#cargo-features">§</a>Cargo features</h2>
<p>This implementation has two independent features, each of which provides an implementation providing
types <code>Map</code>, <code>AnyMap</code>, <code>OccupiedEntry</code>, <code>VacantEntry</code>, <code>Entry</code> and <code>RawMap</code>:</p>
<ul>
<li><strong>std</strong> (default, <em>enabled</em> in this build):
an implementation using <code>std::collections::hash_map</code>, placed in the crate root
(e.g. <code>anymap::AnyMap</code>).</li>
</ul>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Map.html" title="struct stdx::anymap::Map">Map</a></dt><dd>A collection containing zero or one values for any given type and allowing convenient,
type-safe access to those values.</dd><dt><a class="struct" href="struct.OccupiedEntry.html" title="struct stdx::anymap::OccupiedEntry">Occupied<wbr>Entry</a></dt><dd>A view into a single occupied location in an <code>Map</code>.</dd><dt><a class="struct" href="struct.TypeIdHasher.html" title="struct stdx::anymap::TypeIdHasher">Type<wbr>IdHasher</a></dt><dd>A hasher designed to eke a little more speed out, given <code>TypeId</code>s known characteristics.</dd><dt><a class="struct" href="struct.VacantEntry.html" title="struct stdx::anymap::VacantEntry">Vacant<wbr>Entry</a></dt><dd>A view into a single empty location in an <code>Map</code>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Entry.html" title="enum stdx::anymap::Entry">Entry</a></dt><dd>A view into a single location in an <code>Map</code>, which may be vacant or occupied.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Downcast.html" title="trait stdx::anymap::Downcast">Downcast</a></dt><dd>Methods for downcasting from an <code>Any</code>-like trait object.</dd><dt><a class="trait" href="trait.IntoBox.html" title="trait stdx::anymap::IntoBox">IntoBox</a></dt><dd>A trait for the conversion of an object into a boxed trait object.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.AnyMap.html" title="type stdx::anymap::AnyMap">AnyMap</a></dt><dd>The most common type of <code>Map</code>: just using <code>Any</code>; <code>[Map]&lt;dyn [Any]&gt;</code>.</dd><dt><a class="type" href="type.RawMap.html" title="type stdx::anymap::RawMap">RawMap</a></dt><dd>Raw access to the underlying <code>HashMap</code>.</dd></dl></section></div></main></body></html>