mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-16 13:00:40 +00:00
Deploying to gh-pages from @ GreptimeTeam/greptimedb@0572a680af 🚀
This commit is contained in:
1
common_memory_manager/all.html
Normal file
1
common_memory_manager/all.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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="List of all items in this crate"><title>List of all items in this crate</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="../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 mod sys"><!--[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="#">All</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>List of all items</h1><rustdoc-toolbar></rustdoc-toolbar></div><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.MemoryGuard.html">MemoryGuard</a></li><li><a href="struct.MemoryManager.html">MemoryManager</a></li><li><a href="struct.NoOpMetrics.html">NoOpMetrics</a></li><li><a href="error/struct.MemoryAcquireTimeoutSnafu.html">error::MemoryAcquireTimeoutSnafu</a></li><li><a href="error/struct.MemoryLimitExceededSnafu.html">error::MemoryLimitExceededSnafu</a></li><li><a href="error/struct.MemorySemaphoreClosedSnafu.html">error::MemorySemaphoreClosedSnafu</a></li><li><a href="guard/struct.MemoryGuard.html">guard::MemoryGuard</a></li><li><a href="manager/struct.MemoryManager.html">manager::MemoryManager</a></li><li><a href="manager/struct.MemoryQuota.html">manager::MemoryQuota</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="enum.Error.html">Error</a></li><li><a href="enum.OnExhaustedPolicy.html">OnExhaustedPolicy</a></li><li><a href="enum.PermitGranularity.html">PermitGranularity</a></li><li><a href="error/enum.Error.html">error::Error</a></li><li><a href="granularity/enum.PermitGranularity.html">granularity::PermitGranularity</a></li><li><a href="guard/enum.GuardState.html">guard::GuardState</a></li><li><a href="policy/enum.OnExhaustedPolicy.html">policy::OnExhaustedPolicy</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.MemoryMetrics.html">MemoryMetrics</a></li><li><a href="manager/trait.MemoryMetrics.html">manager::MemoryMetrics</a></li></ul><h3 id="types">Type Aliases</h3><ul class="all-items"><li><a href="type.Result.html">Result</a></li><li><a href="error/type.Result.html">error::Result</a></li></ul><h3 id="constants">Constants</h3><ul class="all-items"><li><a href="constant.DEFAULT_MEMORY_WAIT_TIMEOUT.html">DEFAULT_MEMORY_WAIT_TIMEOUT</a></li><li><a href="policy/constant.DEFAULT_MEMORY_WAIT_TIMEOUT.html">policy::DEFAULT_MEMORY_WAIT_TIMEOUT</a></li></ul></section></div></main></body></html>
|
||||
@@ -0,0 +1,2 @@
|
||||
<!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="Default wait timeout for memory acquisition."><title>DEFAULT_MEMORY_WAIT_TIMEOUT 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 constant"><!--[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="#">DEFAULT_MEMORY_WAIT_TIMEOUT</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-rc.2</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></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>Constant <span class="constant">DEFAULT_<wbr>MEMORY_<wbr>WAIT_<wbr>TIMEOUT</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/common_memory_manager/policy.rs.html#21">Source</a> </span></div><pre class="rust item-decl"><code>pub const DEFAULT_MEMORY_WAIT_TIMEOUT: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Default wait timeout for memory acquisition.</p>
|
||||
</div></details></section></div></main></body></html>
|
||||
212
common_memory_manager/enum.Error.html
Normal file
212
common_memory_manager/enum.Error.html
Normal file
File diff suppressed because one or more lines are too long
199
common_memory_manager/enum.OnExhaustedPolicy.html
Normal file
199
common_memory_manager/enum.OnExhaustedPolicy.html
Normal file
File diff suppressed because one or more lines are too long
215
common_memory_manager/enum.PermitGranularity.html
Normal file
215
common_memory_manager/enum.PermitGranularity.html
Normal file
File diff suppressed because one or more lines are too long
212
common_memory_manager/error/enum.Error.html
Normal file
212
common_memory_manager/error/enum.Error.html
Normal file
File diff suppressed because one or more lines are too long
1
common_memory_manager/error/index.html
Normal file
1
common_memory_manager/error/index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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 `error` mod in crate `common_memory_manager`."><title>common_memory_manager::error - 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 mod"><!--[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="#">Module error</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module error</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></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>Module <span>error</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/common_memory_manager/error.rs.html#15-63">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.MemoryAcquireTimeoutSnafu.html" title="struct common_memory_manager::error::MemoryAcquireTimeoutSnafu">Memory<wbr>Acquire<wbr>Timeout<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>Error::MemoryAcquireTimeout</code> variant</dd><dt><a class="struct" href="struct.MemoryLimitExceededSnafu.html" title="struct common_memory_manager::error::MemoryLimitExceededSnafu">Memory<wbr>Limit<wbr>Exceeded<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>Error::MemoryLimitExceeded</code> variant</dd><dt><a class="struct" href="struct.MemorySemaphoreClosedSnafu.html" title="struct common_memory_manager::error::MemorySemaphoreClosedSnafu">Memory<wbr>Semaphore<wbr>Closed<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>Error::MemorySemaphoreClosed</code> variant</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Error.html" title="enum common_memory_manager::error::Error">Error</a></dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Result.html" title="type common_memory_manager::error::Result">Result</a></dt></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/error/sidebar-items.js
Normal file
1
common_memory_manager/error/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":["Error"],"struct":["MemoryAcquireTimeoutSnafu","MemoryLimitExceededSnafu","MemorySemaphoreClosedSnafu"],"type":["Result"]};
|
||||
File diff suppressed because one or more lines are too long
210
common_memory_manager/error/struct.MemoryLimitExceededSnafu.html
Normal file
210
common_memory_manager/error/struct.MemoryLimitExceededSnafu.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
6
common_memory_manager/error/type.Result.html
Normal file
6
common_memory_manager/error/type.Result.html
Normal file
@@ -0,0 +1,6 @@
|
||||
<!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 `Result` type in crate `common_memory_manager`."><title>Result in common_memory_manager::error - 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 type"><!--[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="#">Result</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result</a></h2><h3><a href="#aliased-type">Aliased Type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.Err" title="Err">Err</a></li><li><a href="#variant.Ok" title="Ok">Ok</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>memory_<wbr>manager::<wbr>error</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>::<wbr><a href="index.html">error</a></div><h1>Type Alias <span class="type">Result</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/common_memory_manager/error.rs.html#23">Source</a> </span></div><pre class="rust item-decl"><code>pub type Result<T> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="../enum.Error.html" title="enum common_memory_manager::Error">Error</a>>;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>pub enum Result<T> {
|
||||
Ok(T),
|
||||
Err(<a class="enum" href="../enum.Error.html" title="enum common_memory_manager::Error">Error</a>),
|
||||
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Ok" class="variant"><a href="#variant.Ok" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Ok(T)</h3></section><div class="docblock"><p>Contains the success value</p>
|
||||
</div><section id="variant.Err" class="variant"><a href="#variant.Err" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Err(<a class="enum" href="../enum.Error.html" title="enum common_memory_manager::Error">Error</a>)</h3></section><div class="docblock"><p>Contains the error value</p>
|
||||
</div></div><script src="../../type.impl/core/result/enum.Result.js" data-self-path="common_memory_manager::error::Result" async></script></section></div></main></body></html>
|
||||
215
common_memory_manager/granularity/enum.PermitGranularity.html
Normal file
215
common_memory_manager/granularity/enum.PermitGranularity.html
Normal file
File diff suppressed because one or more lines are too long
1
common_memory_manager/granularity/index.html
Normal file
1
common_memory_manager/granularity/index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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 `granularity` mod in crate `common_memory_manager`."><title>common_memory_manager::granularity - 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 mod"><!--[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="#">Module granularity</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module granularity</a></h2><h3><a href="#enums">Module Items</a></h3><ul class="block"><li><a href="#enums" title="Enums">Enums</a></li></ul></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>Module <span>granularity</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/common_memory_manager/granularity.rs.html#15-168">Source</a> </span></div><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.PermitGranularity.html" title="enum common_memory_manager::granularity::PermitGranularity">Permit<wbr>Granularity</a></dt><dd>Memory permit granularity for different use cases.</dd></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/granularity/sidebar-items.js
Normal file
1
common_memory_manager/granularity/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":["PermitGranularity"]};
|
||||
186
common_memory_manager/guard/enum.GuardState.html
Normal file
186
common_memory_manager/guard/enum.GuardState.html
Normal file
File diff suppressed because one or more lines are too long
1
common_memory_manager/guard/index.html
Normal file
1
common_memory_manager/guard/index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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 `guard` mod in crate `common_memory_manager`."><title>common_memory_manager::guard - 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 mod"><!--[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="#">Module guard</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module guard</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></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>Module <span>guard</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/common_memory_manager/guard.rs.html#15-231">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.MemoryGuard.html" title="struct common_memory_manager::guard::MemoryGuard">Memory<wbr>Guard</a></dt><dd>Guard representing a slice of reserved memory.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.GuardState.html" title="enum common_memory_manager::guard::GuardState">Guard<wbr>State</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/guard/sidebar-items.js
Normal file
1
common_memory_manager/guard/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":["GuardState"],"struct":["MemoryGuard"]};
|
||||
214
common_memory_manager/guard/struct.MemoryGuard.html
Normal file
214
common_memory_manager/guard/struct.MemoryGuard.html
Normal file
File diff suppressed because one or more lines are too long
5
common_memory_manager/index.html
Normal file
5
common_memory_manager/index.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<!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="Generic memory management for resource-constrained operations."><title>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="../crates.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 mod crate"><!--[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="#">Crate common_memory_manager</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-rc.2</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>common_<wbr>memory_<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/common_memory_manager/lib.rs.html#15-49">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generic memory management for resource-constrained operations.</p>
|
||||
<p>This crate provides a reusable memory quota system based on semaphores,
|
||||
allowing different subsystems (compaction, flush, index build, etc.) to
|
||||
share the same allocation logic while using their own metrics.</p>
|
||||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="error/index.html" title="mod common_memory_manager::error">error</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="granularity/index.html" title="mod common_memory_manager::granularity">granularity</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="guard/index.html" title="mod common_memory_manager::guard">guard</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="manager/index.html" title="mod common_memory_manager::manager">manager</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="policy/index.html" title="mod common_memory_manager::policy">policy</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.MemoryGuard.html" title="struct common_memory_manager::MemoryGuard">Memory<wbr>Guard</a></dt><dd>Guard representing a slice of reserved memory.</dd><dt><a class="struct" href="struct.MemoryManager.html" title="struct common_memory_manager::MemoryManager">Memory<wbr>Manager</a></dt><dd>Generic memory manager for quota-controlled operations.</dd><dt><a class="struct" href="struct.NoOpMetrics.html" title="struct common_memory_manager::NoOpMetrics">NoOp<wbr>Metrics</a></dt><dd>No-op metrics implementation for testing.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Error.html" title="enum common_memory_manager::Error">Error</a></dt><dt><a class="enum" href="enum.OnExhaustedPolicy.html" title="enum common_memory_manager::OnExhaustedPolicy">OnExhausted<wbr>Policy</a></dt><dd>Defines how to react when memory cannot be acquired immediately.</dd><dt><a class="enum" href="enum.PermitGranularity.html" title="enum common_memory_manager::PermitGranularity">Permit<wbr>Granularity</a></dt><dd>Memory permit granularity for different use cases.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DEFAULT_MEMORY_WAIT_TIMEOUT.html" title="constant common_memory_manager::DEFAULT_MEMORY_WAIT_TIMEOUT">DEFAULT_<wbr>MEMORY_<wbr>WAIT_<wbr>TIMEOUT</a></dt><dd>Default wait timeout for memory acquisition.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.MemoryMetrics.html" title="trait common_memory_manager::MemoryMetrics">Memory<wbr>Metrics</a></dt><dd>Trait for recording memory usage metrics.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Result.html" title="type common_memory_manager::Result">Result</a></dt></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/manager/index.html
Normal file
1
common_memory_manager/manager/index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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 `manager` mod in crate `common_memory_manager`."><title>common_memory_manager::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 mod"><!--[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="#">Module manager</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module manager</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></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>Module <span>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/common_memory_manager/manager.rs.html#15-222">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.MemoryManager.html" title="struct common_memory_manager::manager::MemoryManager">Memory<wbr>Manager</a></dt><dd>Generic memory manager for quota-controlled operations.</dd><dt><a class="struct" href="struct.MemoryQuota.html" title="struct common_memory_manager::manager::MemoryQuota">Memory<wbr>Quota</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.MemoryMetrics.html" title="trait common_memory_manager::manager::MemoryMetrics">Memory<wbr>Metrics</a></dt><dd>Trait for recording memory usage metrics.</dd></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/manager/sidebar-items.js
Normal file
1
common_memory_manager/manager/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"struct":["MemoryManager","MemoryQuota"],"trait":["MemoryMetrics"]};
|
||||
222
common_memory_manager/manager/struct.MemoryManager.html
Normal file
222
common_memory_manager/manager/struct.MemoryManager.html
Normal file
File diff suppressed because one or more lines are too long
192
common_memory_manager/manager/struct.MemoryQuota.html
Normal file
192
common_memory_manager/manager/struct.MemoryQuota.html
Normal file
File diff suppressed because one or more lines are too long
11
common_memory_manager/manager/trait.MemoryMetrics.html
Normal file
11
common_memory_manager/manager/trait.MemoryMetrics.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<!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::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-rc.2</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><a href="index.html">In common_<wbr>memory_<wbr>manager::<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>::<wbr><a href="index.html">manager</a></div><h1>Trait <span class="trait">Memory<wbr>Metrics</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/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>(&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>(&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>(&self, reason: &<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>(&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>(&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>(&self, reason: &<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>
|
||||
@@ -0,0 +1,2 @@
|
||||
<!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="Default wait timeout for memory acquisition."><title>DEFAULT_MEMORY_WAIT_TIMEOUT in common_memory_manager::policy - 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 constant"><!--[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="#">DEFAULT_MEMORY_WAIT_TIMEOUT</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-rc.2</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>memory_<wbr>manager::<wbr>policy</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>::<wbr><a href="index.html">policy</a></div><h1>Constant <span class="constant">DEFAULT_<wbr>MEMORY_<wbr>WAIT_<wbr>TIMEOUT</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/common_memory_manager/policy.rs.html#21">Source</a> </span></div><pre class="rust item-decl"><code>pub const DEFAULT_MEMORY_WAIT_TIMEOUT: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Default wait timeout for memory acquisition.</p>
|
||||
</div></details></section></div></main></body></html>
|
||||
199
common_memory_manager/policy/enum.OnExhaustedPolicy.html
Normal file
199
common_memory_manager/policy/enum.OnExhaustedPolicy.html
Normal file
File diff suppressed because one or more lines are too long
1
common_memory_manager/policy/index.html
Normal file
1
common_memory_manager/policy/index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!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 `policy` mod in crate `common_memory_manager`."><title>common_memory_manager::policy - 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 mod"><!--[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="#">Module policy</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module policy</a></h2><h3><a href="#enums">Module Items</a></h3><ul class="block"><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li></ul></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>Module <span>policy</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/common_memory_manager/policy.rs.html#15-83">Source</a> </span></div><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.OnExhaustedPolicy.html" title="enum common_memory_manager::policy::OnExhaustedPolicy">OnExhausted<wbr>Policy</a></dt><dd>Defines how to react when memory cannot be acquired immediately.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DEFAULT_MEMORY_WAIT_TIMEOUT.html" title="constant common_memory_manager::policy::DEFAULT_MEMORY_WAIT_TIMEOUT">DEFAULT_<wbr>MEMORY_<wbr>WAIT_<wbr>TIMEOUT</a></dt><dd>Default wait timeout for memory acquisition.</dd></dl></section></div></main></body></html>
|
||||
1
common_memory_manager/policy/sidebar-items.js
Normal file
1
common_memory_manager/policy/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"constant":["DEFAULT_MEMORY_WAIT_TIMEOUT"],"enum":["OnExhaustedPolicy"]};
|
||||
1
common_memory_manager/sidebar-items.js
Normal file
1
common_memory_manager/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"constant":["DEFAULT_MEMORY_WAIT_TIMEOUT"],"enum":["Error","OnExhaustedPolicy","PermitGranularity"],"mod":["error","granularity","guard","manager","policy"],"struct":["MemoryGuard","MemoryManager","NoOpMetrics"],"trait":["MemoryMetrics"],"type":["Result"]};
|
||||
214
common_memory_manager/struct.MemoryGuard.html
Normal file
214
common_memory_manager/struct.MemoryGuard.html
Normal file
File diff suppressed because one or more lines are too long
222
common_memory_manager/struct.MemoryManager.html
Normal file
222
common_memory_manager/struct.MemoryManager.html
Normal file
File diff suppressed because one or more lines are too long
186
common_memory_manager/struct.NoOpMetrics.html
Normal file
186
common_memory_manager/struct.NoOpMetrics.html
Normal file
File diff suppressed because one or more lines are too long
11
common_memory_manager/trait.MemoryMetrics.html
Normal file
11
common_memory_manager/trait.MemoryMetrics.html
Normal file
@@ -0,0 +1,11 @@
|
||||
<!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-rc.2</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> <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>(&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>(&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>(&self, reason: &<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>(&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>(&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>(&self, reason: &<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>
|
||||
6
common_memory_manager/type.Result.html
Normal file
6
common_memory_manager/type.Result.html
Normal file
@@ -0,0 +1,6 @@
|
||||
<!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 `Result` type in crate `common_memory_manager`."><title>Result 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 type"><!--[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="#">Result</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result</a></h2><h3><a href="#aliased-type">Aliased Type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.Err" title="Err">Err</a></li><li><a href="#variant.Ok" title="Ok">Ok</a></li></ul></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>Type Alias <span class="type">Result</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/common_memory_manager/error.rs.html#23">Source</a> </span></div><pre class="rust item-decl"><code>pub type Result<T> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="enum.Error.html" title="enum common_memory_manager::Error">Error</a>>;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>pub enum Result<T> {
|
||||
Ok(T),
|
||||
Err(<a class="enum" href="enum.Error.html" title="enum common_memory_manager::Error">Error</a>),
|
||||
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Ok" class="variant"><a href="#variant.Ok" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Ok(T)</h3></section><div class="docblock"><p>Contains the success value</p>
|
||||
</div><section id="variant.Err" class="variant"><a href="#variant.Err" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Err(<a class="enum" href="enum.Error.html" title="enum common_memory_manager::Error">Error</a>)</h3></section><div class="docblock"><p>Contains the error value</p>
|
||||
</div></div><script src="../type.impl/core/result/enum.Result.js" data-self-path="common_memory_manager::error::Result" async></script></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user