53 lines
9.1 KiB
HTML
53 lines
9.1 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 `Record` trait in crate `ironsea_index`."><meta name="keywords" content="rust, rustlang, rust-lang, Record"><title>ironsea_index::Record - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../ironsea_index/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Record</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.key">key</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>ironsea_index</a></p><script>window.sidebarCurrent = {name: 'Record', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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 class='srclink' href='../src/ironsea_index/lib.rs.html#79-82' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>ironsea_index</a>::<wbr><a class="trait" href=''>Record</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Record<K> {
|
||
fn <a href='#tymethod.key' class='fnname'>key</a>(&self) -> K;
|
||
}</pre></div><div class='docblock'><p>Record behavior used by Indexed implementations.</p>
|
||
<p>This trait provides common methods used by index implementations to
|
||
retrieve information about a single record. This is provided by the
|
||
users of indices, for each of their <code>struct</code> they wish to index.</p>
|
||
<p>Multiple implementation can be provided, as long as their types are
|
||
different.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">ironsea_index</span>::<span class="ident">Record</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">MyPair</span> {
|
||
<span class="ident">a</span>: <span class="ident">i64</span>,
|
||
<span class="ident">b</span>: <span class="ident">i64</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Record</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MyPair</span> {
|
||
<span class="kw">fn</span> <span class="ident">key</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="self">self</span>.<span class="ident">a</span>)
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Record</span><span class="op"><</span><span class="ident">i64</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MyPair</span> {
|
||
<span class="kw">fn</span> <span class="ident">key</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">i64</span> {
|
||
<span class="self">self</span>.<span class="ident">a</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
|
||
<span class="kw">let</span> <span class="ident">table</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">MyPair</span>{ <span class="ident">a</span>: <span class="number">10</span>, <span class="ident">b</span>:<span class="number">34</span>}, <span class="ident">MyPair</span>{ <span class="ident">a</span>: <span class="number">1</span>, <span class="ident">b</span>:<span class="number">56</span>}, <span class="ident">MyPair</span>{ <span class="ident">a</span>: <span class="number">2</span>, <span class="ident">b</span>:<span class="number">23</span>}];
|
||
|
||
<span class="comment">// Example without using an actual index crate, we will simply use</span>
|
||
<span class="comment">// the Record<K> trait to sort the array of pairs.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">lex_sort</span> <span class="op">=</span> <span class="ident">table</span>.<span class="ident">clone</span>();
|
||
<span class="ident">lex_sort</span>.<span class="ident">sort_unstable_by_key</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> {<span class="kw">let</span> <span class="ident">k</span>: <span class="ident">String</span> <span class="op">=</span> <span class="ident">e</span>.<span class="ident">key</span>(); <span class="ident">k</span>});
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">num_sort</span> <span class="op">=</span> <span class="ident">table</span>.<span class="ident">clone</span>();
|
||
<span class="ident">num_sort</span>.<span class="ident">sort_unstable_by_key</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> {<span class="kw">let</span> <span class="ident">k</span>: <span class="ident">i64</span> <span class="op">=</span> <span class="ident">e</span>.<span class="ident">key</span>(); <span class="ident">k</span>});
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"unsorted {:?}"</span>, <span class="ident">table</span>),
|
||
<span class="string">"unsorted [MyPair { a: 10, b: 34 }, MyPair { a: 1, b: 56 }, MyPair { a: 2, b: 23 }]"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"lex sort {:?}"</span>, <span class="ident">lex_sort</span>),
|
||
<span class="string">"lex sort [MyPair { a: 1, b: 56 }, MyPair { a: 10, b: 34 }, MyPair { a: 2, b: 23 }]"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"num sort {:?}"</span>, <span class="ident">num_sort</span>),
|
||
<span class="string">"num sort [MyPair { a: 1, b: 56 }, MyPair { a: 2, b: 23 }, MyPair { a: 10, b: 34 }]"</span>);
|
||
}</pre></div>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.key' class='method'><code id='key.v'>fn <a href='#tymethod.key' class='fnname'>key</a>(&self) -> K</code></h3><div class='docblock'><p>Extract the key from the record.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/ironsea_index/trait.Record.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "ironsea_index";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |