| <!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="Source of the Rust file `common/rusty_leveldb_sgx/src/options.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>options.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../rusty_leveldb/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rusty_leveldb/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::block::Block; |
| <span class="kw">use </span><span class="kw">crate</span>::cache::Cache; |
| <span class="kw">use </span><span class="kw">crate</span>::cmp::{Cmp, DefaultCmp}; |
| <span class="kw">use </span><span class="kw">crate</span>::disk_env; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::env::Env; |
| <span class="kw">use </span><span class="kw">crate</span>::filter; |
| <span class="kw">use </span><span class="kw">crate</span>::infolog::{<span class="self">self</span>, Logger}; |
| <span class="kw">use </span><span class="kw">crate</span>::mem_env::MemEnv; |
| <span class="kw">use </span><span class="kw">crate</span>::types::{share, Shared}; |
| |
| <span class="kw">use </span>std::rc::Rc; |
| |
| <span class="kw">use </span>disk_env::DBPersistKey; |
| |
| <span class="kw">const </span>KB: usize = <span class="number">1 </span><< <span class="number">10</span>; |
| <span class="kw">const </span>MB: usize = KB * KB; |
| |
| <span class="kw">const </span>BLOCK_MAX_SIZE: usize = <span class="number">4 </span>* KB; |
| <span class="kw">const </span>BLOCK_CACHE_CAPACITY: usize = <span class="number">8 </span>* MB; |
| <span class="kw">const </span>WRITE_BUFFER_SIZE: usize = <span class="number">4 </span>* MB; |
| <span class="kw">const </span>DEFAULT_BITS_PER_KEY: u32 = <span class="number">10</span>; <span class="comment">// NOTE: This may need to be optimized. |
| |
| </span><span class="attribute">#[derive(Clone, Copy, PartialEq, Debug)] |
| </span><span class="kw">pub enum </span>CompressionType { |
| CompressionNone = <span class="number">0</span>, |
| CompressionSnappy = <span class="number">1</span>, |
| } |
| |
| <span class="kw">pub fn </span>int_to_compressiontype(i: u32) -> <span class="prelude-ty">Option</span><CompressionType> { |
| <span class="kw">match </span>i { |
| <span class="number">0 </span>=> <span class="prelude-val">Some</span>(CompressionType::CompressionNone), |
| <span class="number">1 </span>=> <span class="prelude-val">Some</span>(CompressionType::CompressionSnappy), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Options contains general parameters for a LevelDB instance. Most of the names are |
| /// self-explanatory; the defaults are defined in the `Default` implementation. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Options { |
| <span class="kw">pub </span>cmp: Rc<Box<<span class="kw">dyn </span>Cmp>>, |
| <span class="kw">pub </span>env: Rc<Box<<span class="kw">dyn </span>Env>>, |
| <span class="kw">pub </span>log: <span class="prelude-ty">Option</span><Shared<Logger>>, |
| <span class="kw">pub </span>create_if_missing: bool, |
| <span class="kw">pub </span>error_if_exists: bool, |
| <span class="kw">pub </span>paranoid_checks: bool, |
| <span class="kw">pub </span>write_buffer_size: usize, |
| <span class="kw">pub </span>max_open_files: usize, |
| <span class="kw">pub </span>max_file_size: usize, |
| <span class="kw">pub </span>block_cache: Shared<Cache<Block>>, |
| <span class="kw">pub </span>block_size: usize, |
| <span class="kw">pub </span>block_restart_interval: usize, |
| <span class="kw">pub </span>compression_type: CompressionType, |
| <span class="kw">pub </span>reuse_logs: bool, |
| <span class="kw">pub </span>reuse_manifest: bool, |
| <span class="kw">pub </span>filter_policy: filter::BoxedFilterPolicy, |
| } |
| |
| <span class="kw">impl </span>Options { |
| <span class="kw">pub fn </span>new_disk_db_with(key: DBPersistKey) -> Options { |
| Options { |
| cmp: Rc::new(Box::new(DefaultCmp)), |
| env: Rc::new(Box::new(disk_env::PosixDiskEnv::new_with(key))), |
| log: <span class="prelude-val">None</span>, |
| create_if_missing: <span class="bool-val">true</span>, |
| error_if_exists: <span class="bool-val">false</span>, |
| paranoid_checks: <span class="bool-val">false</span>, |
| write_buffer_size: WRITE_BUFFER_SIZE, |
| max_open_files: <span class="number">1 </span><< <span class="number">10</span>, |
| max_file_size: <span class="number">2 </span><< <span class="number">20</span>, |
| <span class="comment">// 2000 elements by default |
| </span>block_cache: share(Cache::new(BLOCK_CACHE_CAPACITY / BLOCK_MAX_SIZE)), |
| block_size: BLOCK_MAX_SIZE, |
| block_restart_interval: <span class="number">16</span>, |
| reuse_logs: <span class="bool-val">true</span>, |
| reuse_manifest: <span class="bool-val">true</span>, |
| compression_type: CompressionType::CompressionNone, |
| filter_policy: Rc::new(Box::new(filter::BloomPolicy::new(DEFAULT_BITS_PER_KEY))), |
| } |
| } |
| |
| <span class="kw">pub fn </span>new_mem_db() -> Options { |
| Options { |
| cmp: Rc::new(Box::new(DefaultCmp)), |
| env: Rc::new(Box::new(MemEnv::new())), |
| log: <span class="prelude-val">None</span>, |
| create_if_missing: <span class="bool-val">true</span>, |
| error_if_exists: <span class="bool-val">false</span>, |
| paranoid_checks: <span class="bool-val">false</span>, |
| write_buffer_size: WRITE_BUFFER_SIZE, |
| max_open_files: <span class="number">1 </span><< <span class="number">10</span>, |
| max_file_size: <span class="number">2 </span><< <span class="number">20</span>, |
| <span class="comment">// 2000 elements by default |
| </span>block_cache: share(Cache::new(BLOCK_CACHE_CAPACITY / BLOCK_MAX_SIZE)), |
| block_size: BLOCK_MAX_SIZE, |
| block_restart_interval: <span class="number">16</span>, |
| reuse_logs: <span class="bool-val">true</span>, |
| reuse_manifest: <span class="bool-val">true</span>, |
| compression_type: CompressionType::CompressionNone, |
| filter_policy: Rc::new(Box::new(filter::BloomPolicy::new(DEFAULT_BITS_PER_KEY))), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Returns Options that will cause a database to exist purely in-memory instead of being stored on |
| /// disk. This is useful for testing or ephemeral databases. |
| </span><span class="kw">pub fn </span>in_memory() -> Options { |
| Options::new_mem_db() |
| } |
| |
| <span class="kw">pub fn </span>for_test() -> Options { |
| <span class="kw">let </span><span class="kw-2">mut </span>o = Options::new_mem_db(); |
| o.log = <span class="prelude-val">Some</span>(share(infolog::stderr())); |
| o |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rusty_leveldb" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
