Files
greptimedb/common_memory_manager/trait.MemoryMetrics.html
2025-12-22 06:16:12 +00:00

11 lines
6.9 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="Trait for recording memory usage metrics."><title>MemoryMetrics in common_memory_manager - 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="common_memory_manager" 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="#">MemoryMetrics</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_memory_manager/index.html">common_<wbr>memory_<wbr>manager</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="#">Memory<wbr>Metrics</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.inc_rejected" title="inc_rejected">inc_rejected</a></li><li><a href="#tymethod.set_in_use" title="set_in_use">set_in_use</a></li><li><a href="#tymethod.set_limit" title="set_limit">set_limit</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate common_<wbr>memory_<wbr>manager</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">common_memory_manager</a></div><h1>Trait <span class="trait">Memory<wbr>Metrics</span>&nbsp;<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/common_memory_manager/manager.rs.html#28-32">Source</a> </span></div><pre class="rust item-decl"><code>pub trait MemoryMetrics:
<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>
+ <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>
+ 'static {
// Required methods
fn <a href="#tymethod.set_limit" class="fn">set_limit</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.set_in_use" class="fn">set_in_use</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.inc_rejected" class="fn">inc_rejected</a>(&amp;self, reason: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>);
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for recording memory usage metrics.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.set_limit" class="method"><a class="src rightside" href="../src/common_memory_manager/manager.rs.html#29">Source</a><h4 class="code-header">fn <a href="#tymethod.set_limit" class="fn">set_limit</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>)</h4></section><section id="tymethod.set_in_use" class="method"><a class="src rightside" href="../src/common_memory_manager/manager.rs.html#30">Source</a><h4 class="code-header">fn <a href="#tymethod.set_in_use" class="fn">set_in_use</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>)</h4></section><section id="tymethod.inc_rejected" class="method"><a class="src rightside" href="../src/common_memory_manager/manager.rs.html#31">Source</a><h4 class="code-header">fn <a href="#tymethod.inc_rejected" class="fn">inc_rejected</a>(&amp;self, reason: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</h4></section></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-MemoryMetrics-for-NoOpMetrics" class="impl"><a class="src rightside" href="../src/common_memory_manager/lib.rs.html#40-49">Source</a><a href="#impl-MemoryMetrics-for-NoOpMetrics" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.MemoryMetrics.html" title="trait common_memory_manager::MemoryMetrics">MemoryMetrics</a> for <a class="struct" href="struct.NoOpMetrics.html" title="struct common_memory_manager::NoOpMetrics">NoOpMetrics</a></h3></section></div><script src="../trait.impl/common_memory_manager/manager/trait.MemoryMetrics.js" async></script></section></div></main></body></html>