mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-14 17:23:09 +00:00
26 lines
10 KiB
HTML
26 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="Global write buffer (memtable) manager."><title>WriteBufferManager in mito2::flush - 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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">WriteBufferManager</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../mito2/index.html">mito2</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Write<wbr>Buffer<wbr>Manager</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.flush_limit" title="flush_limit">flush_limit</a></li><li><a href="#tymethod.free_mem" title="free_mem">free_mem</a></li><li><a href="#tymethod.memory_usage" title="memory_usage">memory_usage</a></li><li><a href="#tymethod.reserve_mem" title="reserve_mem">reserve_mem</a></li><li><a href="#tymethod.schedule_free_mem" title="schedule_free_mem">schedule_free_mem</a></li><li><a href="#tymethod.should_flush_engine" title="should_flush_engine">should_flush_engine</a></li><li><a href="#tymethod.should_stall" title="should_stall">should_stall</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In mito2::<wbr>flush</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">mito2</a>::<wbr><a href="index.html">flush</a></div><h1>Trait <span class="trait">Write<wbr>Buffer<wbr>Manager</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/mito2/flush.rs.html#71-98">Source</a> </span></div><pre class="rust item-decl"><code>pub trait WriteBufferManager:
|
|
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.should_flush_engine" class="fn">should_flush_engine</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.should_stall" class="fn">should_stall</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.reserve_mem" class="fn">reserve_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.schedule_free_mem" class="fn">schedule_free_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.free_mem" class="fn">free_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.memory_usage" class="fn">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.flush_limit" class="fn">flush_limit</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Global write buffer (memtable) manager.</p>
|
|
<p>Tracks write buffer (memtable) usages and decide whether the engine needs to flush.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.should_flush_engine" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#73">Source</a><h4 class="code-header">fn <a href="#tymethod.should_flush_engine" class="fn">should_flush_engine</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether to trigger the engine.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.should_stall" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#76">Source</a><h4 class="code-header">fn <a href="#tymethod.should_stall" class="fn">should_stall</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether to stall write requests.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.reserve_mem" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#79">Source</a><h4 class="code-header">fn <a href="#tymethod.reserve_mem" class="fn">reserve_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserves <code>mem</code> bytes.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.schedule_free_mem" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#85">Source</a><h4 class="code-header">fn <a href="#tymethod.schedule_free_mem" class="fn">schedule_free_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Tells the manager we are freeing <code>mem</code> bytes.</p>
|
|
<p>We are in the process of freeing <code>mem</code> bytes, so it is not considered
|
|
when checking the soft limit.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.free_mem" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#88">Source</a><h4 class="code-header">fn <a href="#tymethod.free_mem" class="fn">free_mem</a>(&self, mem: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>We have freed <code>mem</code> bytes.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.memory_usage" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#91">Source</a><h4 class="code-header">fn <a href="#tymethod.memory_usage" class="fn">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the total memory used by memtables.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flush_limit" class="method"><a class="src rightside" href="../../src/mito2/flush.rs.html#97">Source</a><h4 class="code-header">fn <a href="#tymethod.flush_limit" class="fn">flush_limit</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the mutable memtable memory limit.</p>
|
|
<p>The write buffer manager should flush memtables when the mutable memory usage
|
|
exceeds this limit.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-WriteBufferManager-for-WriteBufferManagerImpl" class="impl"><a class="src rightside" href="../../src/mito2/flush.rs.html#151-203">Source</a><a href="#impl-WriteBufferManager-for-WriteBufferManagerImpl" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.WriteBufferManager.html" title="trait mito2::flush::WriteBufferManager">WriteBufferManager</a> for <a class="struct" href="struct.WriteBufferManagerImpl.html" title="struct mito2::flush::WriteBufferManagerImpl">WriteBufferManagerImpl</a></h3></section></div><script src="../../trait.impl/mito2/flush/trait.WriteBufferManager.js" async></script></section></div></main></body></html> |