mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 20:40:39 +00:00
3 lines
5.6 KiB
HTML
3 lines
5.6 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="API documentation for the Rust `resource` mod in crate `common_stat`."><title>common_stat::resource - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_stat" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.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"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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 resource</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_stat/index.html">common_<wbr>stat</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module resource</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><li><a href="#functions" title="Functions">Functions</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>stat</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">common_stat</a></div><h1>Module <span>resource</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_stat/resource.rs.html#15-198">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.ResourceStatImpl.html" title="struct common_stat::resource::ResourceStatImpl">Resource<wbr>Stat<wbr>Impl</a></dt><dd>A implementation of <code>ResourceStat</code> trait.</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.ResourceStat.html" title="trait common_stat::resource::ResourceStat">Resource<wbr>Stat</a></dt><dd>A trait for getting resource statistics.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.cpu_cores.html" title="fn common_stat::resource::cpu_cores">cpu_<wbr>cores</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.get_total_cpu_cores.html" title="fn common_stat::resource::get_total_cpu_cores">get_<wbr>total_<wbr>cpu_<wbr>cores</a></dt><dd>Get the total CPU cores. The result will be rounded up to the next integer (ceiling).
|
|
For example, if the total CPU is 1.1 cores (1100 millicores) or 1.5 cores (1500 millicores), the result will be 2.</dd><dt><a class="fn" href="fn.get_total_cpu_millicores.html" title="fn common_stat::resource::get_total_cpu_millicores">get_<wbr>total_<wbr>cpu_<wbr>millicores</a></dt><dd>Get the total CPU in millicores. If the CPU limit is unset, it will return the total CPU cores from host system.</dd><dt><a class="fn" href="fn.get_total_memory_bytes.html" title="fn common_stat::resource::get_total_memory_bytes">get_<wbr>total_<wbr>memory_<wbr>bytes</a></dt><dd>Get the total memory in bytes. If the memory limit is unset, it will return the total memory from host system.
|
|
If the system is not supported to get the total host memory, it will return 0.</dd><dt><a class="fn" href="fn.get_total_memory_readable.html" title="fn common_stat::resource::get_total_memory_readable">get_<wbr>total_<wbr>memory_<wbr>readable</a></dt><dd>Get the total memory in readable size.</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.ResourceStatRef.html" title="type common_stat::resource::ResourceStatRef">Resource<wbr>Stat<wbr>Ref</a></dt><dd>A reference to a <code>ResourceStat</code> implementation.</dd></dl></section></div></main></body></html> |