index.html 14.5 KiB
Newer Older
Travis CI User's avatar
Travis CI User committed
<!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 `kv` mod in crate `db`."><meta name="keywords" content="rust, rustlang, rust-lang, kv"><title>db::kv - 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></head><body class="rustdoc mod"><!--[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">&#9776;</div><p class='location'>Module kv</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>db</a></p><script>window.sidebarCurrent = {name: 'kv', ty: 'mod', 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 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"><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/db/kv/mod.rs.html#1-18' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>db</a>::<wbr><a class="mod" href=''>kv</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.AutoFlushingOverlayDatabase.html"
                                  title='struct db::kv::AutoFlushingOverlayDatabase'>AutoFlushingOverlayDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.CacheDatabase.html"
                                  title='struct db::kv::CacheDatabase'>CacheDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.CompactionProfile.html"
                                  title='struct db::kv::CompactionProfile'>CompactionProfile</a></td>
                           <td class='docblock-short'>
                                <p>Compaction profile for the database settings</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DatabaseConfig.html"
                                  title='struct db::kv::DatabaseConfig'>DatabaseConfig</a></td>
                           <td class='docblock-short'>
                                <p>Database configuration</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.DiskDatabase.html"
                                  title='struct db::kv::DiskDatabase'>DiskDatabase</a></td>
                           <td class='docblock-short'>
                                <p>Key-Value database.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.MemoryDatabase.html"
                                  title='struct db::kv::MemoryDatabase'>MemoryDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.OverlayDatabase.html"
                                  title='struct db::kv::OverlayDatabase'>OverlayDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.RawKey.html"
                                  title='struct db::kv::RawKey'>RawKey</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.RawKeyValue.html"
                                  title='struct db::kv::RawKeyValue'>RawKeyValue</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.RawTransaction.html"
                                  title='struct db::kv::RawTransaction'>RawTransaction</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.SharedMemoryDatabase.html"
                                  title='struct db::kv::SharedMemoryDatabase'>SharedMemoryDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="struct" href="struct.Transaction.html"
                                  title='struct db::kv::Transaction'>Transaction</a></td>
                           <td class='docblock-short'>
                                
                           </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.Key.html"
                                  title='enum db::kv::Key'>Key</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.KeyState.html"
                                  title='enum db::kv::KeyState'>KeyState</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.KeyValue.html"
                                  title='enum db::kv::KeyValue'>KeyValue</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.Location.html"
                                  title='enum db::kv::Location'>Location</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.Operation.html"
                                  title='enum db::kv::Operation'>Operation</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.RawOperation.html"
                                  title='enum db::kv::RawOperation'>RawOperation</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.Value.html"
                                  title='enum db::kv::Value'>Value</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_BLOCK_HASHES.html"
                                  title='constant db::kv::COL_BLOCK_HASHES'>COL_BLOCK_HASHES</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_BLOCK_HEADERS.html"
                                  title='constant db::kv::COL_BLOCK_HEADERS'>COL_BLOCK_HEADERS</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_BLOCK_NUMBERS.html"
                                  title='constant db::kv::COL_BLOCK_NUMBERS'>COL_BLOCK_NUMBERS</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_BLOCK_TRANSACTIONS.html"
                                  title='constant db::kv::COL_BLOCK_TRANSACTIONS'>COL_BLOCK_TRANSACTIONS</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_COUNT.html"
                                  title='constant db::kv::COL_COUNT'>COL_COUNT</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_META.html"
                                  title='constant db::kv::COL_META'>COL_META</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_TRANSACTIONS.html"
                                  title='constant db::kv::COL_TRANSACTIONS'>COL_TRANSACTIONS</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="constant" href="constant.COL_TRANSACTIONS_META.html"
                                  title='constant db::kv::COL_TRANSACTIONS_META'>COL_TRANSACTIONS_META</a></td>
                           <td class='docblock-short'>
                                
                           </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.KeyValueDatabase.html"
                                  title='trait db::kv::KeyValueDatabase'>KeyValueDatabase</a></td>
                           <td class='docblock-short'>
                                
                           </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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "db";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>