217 lines
10 KiB
HTML
217 lines
10 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="API documentation for the Rust `typemap` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, typemap">
|
|||
|
|
|
|||
|
|
<title>typemap - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
|
|||
|
|
<p class='location'></p><script>window.sidebarCurrent = {name: 'typemap', ty: 'mod', relpath: '../'};</script>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content mod">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>typemap</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a id='src-0' class='srclink' href='../src/typemap/lib.rs.html#1-352' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>A type-based key value store where one value type is allowed for each key.</p>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='struct' href='struct.OccupiedEntry.html'
|
|||
|
|
title='typemap::OccupiedEntry'>OccupiedEntry</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A view onto an occupied entry in a TypeMap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='struct' href='struct.TypeMap.html'
|
|||
|
|
title='typemap::TypeMap'>TypeMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A map keyed by types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='struct' href='struct.VacantEntry.html'
|
|||
|
|
title='typemap::VacantEntry'>VacantEntry</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A view onto an unoccupied entry in a TypeMap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='enum' href='enum.Entry.html'
|
|||
|
|
title='typemap::Entry'>Entry</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A view onto an entry in a TypeMap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='trait' href='trait.CloneAny.html'
|
|||
|
|
title='typemap::CloneAny'>CloneAny</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A marker trait meant for use as the <code>A</code> parameter in <code>TypeMap</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='trait' href='trait.DebugAny.html'
|
|||
|
|
title='typemap::DebugAny'>DebugAny</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A marker trait meant for use as the <code>A</code> parameter in <code>TypeMap</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='trait' href='trait.Key.html'
|
|||
|
|
title='typemap::Key'>Key</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>This trait defines the relationship between keys and values in a TypeMap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.CloneMap.html'
|
|||
|
|
title='typemap::CloneMap'>CloneMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Clone</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.DebugMap.html'
|
|||
|
|
title='typemap::DebugMap'>DebugMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Debug</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.SendMap.html'
|
|||
|
|
title='typemap::SendMap'>SendMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Send</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.ShareCloneMap.html'
|
|||
|
|
title='typemap::ShareCloneMap'>ShareCloneMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Clone + Send + Sync</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.ShareDebugMap.html'
|
|||
|
|
title='typemap::ShareDebugMap'>ShareDebugMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Debug + Send + Sync</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.ShareMap.html'
|
|||
|
|
title='typemap::ShareMap'>ShareMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Send + Sync</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.SyncMap.html'
|
|||
|
|
title='typemap::SyncMap'>SyncMap</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A version of <code>TypeMap</code> containing only <code>Sync</code> types.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "typemap";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../jquery.js"></script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|