Files
phy/sysinfo/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

6 lines
9.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="For crate-level documentation, all features need to be enabled."><title>sysinfo - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="sysinfo" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../sysinfo/index.html">sysinfo</a><span class="version">0.32.1</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="#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="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>sysinfo</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/sysinfo/lib.rs.html#3-342">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>For crate-level documentation, all features need to be enabled.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CGroupLimits.html" title="struct sysinfo::CGroupLimits">CGroup<wbr>Limits</a></div><div class="desc docblock-short">Contains memory limits for the current process.</div></li><li><div class="item-name"><a class="struct" href="struct.Cpu.html" title="struct sysinfo::Cpu">Cpu</a></div><div class="desc docblock-short">Contains all the methods of the <a href="struct.Cpu.html" title="struct sysinfo::Cpu"><code>Cpu</code></a> struct.</div></li><li><div class="item-name"><a class="struct" href="struct.CpuRefreshKind.html" title="struct sysinfo::CpuRefreshKind">CpuRefresh<wbr>Kind</a></div><div class="desc docblock-short">Used to determine what you want to refresh specifically on the <a href="struct.Cpu.html" title="struct sysinfo::Cpu"><code>Cpu</code></a> type.</div></li><li><div class="item-name"><a class="struct" href="struct.DiskUsage.html" title="struct sysinfo::DiskUsage">Disk<wbr>Usage</a></div><div class="desc docblock-short">Type containing read and written bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.Gid.html" title="struct sysinfo::Gid">Gid</a></div><div class="desc docblock-short">A group id wrapping a platform specific type.</div></li><li><div class="item-name"><a class="struct" href="struct.LoadAvg.html" title="struct sysinfo::LoadAvg">LoadAvg</a></div><div class="desc docblock-short">A struct representing system load average value.</div></li><li><div class="item-name"><a class="struct" href="struct.MemoryRefreshKind.html" title="struct sysinfo::MemoryRefreshKind">Memory<wbr>Refresh<wbr>Kind</a></div><div class="desc docblock-short">Used to determine which memory you want to refresh specifically.</div></li><li><div class="item-name"><a class="struct" href="struct.Pid.html" title="struct sysinfo::Pid">Pid</a></div><div class="desc docblock-short">Process ID.</div></li><li><div class="item-name"><a class="struct" href="struct.Process.html" title="struct sysinfo::Process">Process</a></div><div class="desc docblock-short">Struct containing information of a process.</div></li><li><div class="item-name"><a class="struct" href="struct.ProcessRefreshKind.html" title="struct sysinfo::ProcessRefreshKind">Process<wbr>Refresh<wbr>Kind</a></div><div class="desc docblock-short">Used to determine what you want to refresh specifically on the <a href="struct.Process.html" title="struct sysinfo::Process"><code>Process</code></a> type.</div></li><li><div class="item-name"><a class="struct" href="struct.RefreshKind.html" title="struct sysinfo::RefreshKind">Refresh<wbr>Kind</a></div><div class="desc docblock-short">Used to determine what you want to refresh specifically on the <a href="struct.System.html" title="struct sysinfo::System"><code>System</code></a> type.</div></li><li><div class="item-name"><a class="struct" href="struct.System.html" title="struct sysinfo::System">System</a></div><div class="desc docblock-short">Structs containing systems information such as processes, memory and CPU.</div></li><li><div class="item-name"><a class="struct" href="struct.Uid.html" title="struct sysinfo::Uid">Uid</a></div><div class="desc docblock-short">A user id wrapping a platform specific type.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ProcessStatus.html" title="enum sysinfo::ProcessStatus">Process<wbr>Status</a></div><div class="desc docblock-short">Enum describing the different status of a process.</div></li><li><div class="item-name"><a class="enum" href="enum.ProcessesToUpdate.html" title="enum sysinfo::ProcessesToUpdate">Processes<wbr>ToUpdate</a></div><div class="desc docblock-short">This enum allows you to specify if you want all processes to be updated or just
some of them.</div></li><li><div class="item-name"><a class="enum" href="enum.Signal.html" title="enum sysinfo::Signal">Signal</a></div><div class="desc docblock-short">An enum representing signals on UNIX-like systems.</div></li><li><div class="item-name"><a class="enum" href="enum.ThreadKind.html" title="enum sysinfo::ThreadKind">Thread<wbr>Kind</a></div><div class="desc docblock-short">Enum describing the different kind of threads.</div></li><li><div class="item-name"><a class="enum" href="enum.UpdateKind.html" title="enum sysinfo::UpdateKind">Update<wbr>Kind</a></div><div class="desc docblock-short">This enum allows you to specify when you want the related information to be updated.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.IS_SUPPORTED_SYSTEM.html" title="constant sysinfo::IS_SUPPORTED_SYSTEM">IS_<wbr>SUPPORTED_<wbr>SYSTEM</a></div><div class="desc docblock-short">Returns <code>true</code> if this OS is supported. Please refer to the
<a href="index.html">crate-level documentation</a> to get the list of supported OSes.</div></li><li><div class="item-name"><a class="constant" href="constant.MINIMUM_CPU_UPDATE_INTERVAL.html" title="constant sysinfo::MINIMUM_CPU_UPDATE_INTERVAL">MINIMUM_<wbr>CPU_<wbr>UPDATE_<wbr>INTERVAL</a></div><div class="desc docblock-short">This is the minimum interval time used internally by <code>sysinfo</code> to refresh the CPU time.</div></li><li><div class="item-name"><a class="constant" href="constant.SUPPORTED_SIGNALS.html" title="constant sysinfo::SUPPORTED_SIGNALS">SUPPORTED_<wbr>SIGNALS</a></div><div class="desc docblock-short">Returns the list of the supported signals on this system (used by
<a href="struct.Process.html#method.kill_with" title="method sysinfo::Process::kill_with"><code>Process::kill_with</code></a>).</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.get_current_pid.html" title="fn sysinfo::get_current_pid">get_<wbr>current_<wbr>pid</a></div><div class="desc docblock-short">Returns the pid for the current process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_open_files_limit.html" title="fn sysinfo::set_open_files_limit">set_<wbr>open_<wbr>files_<wbr>limit</a></div><div class="desc docblock-short">This function is only used on Linux targets, when the <code>system</code> feature is enabled. In other
cases, it does nothing and returns <code>false</code>.</div></li></ul></section></div></main></body></html>