diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
commit | 698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch) | |
tree | 173a775858bd501c378080a10dca74132f05bc50 /vendor/sysinfo/md_doc | |
parent | Initial commit. (diff) | |
download | rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip |
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/sysinfo/md_doc')
-rw-r--r-- | vendor/sysinfo/md_doc/component.md | 16 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/cpu.md | 1 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/disk.md | 1 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/network_data.md | 1 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/networks.md | 8 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/pid.md | 20 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/process.md | 10 | ||||
-rw-r--r-- | vendor/sysinfo/md_doc/system.md | 1 |
8 files changed, 58 insertions, 0 deletions
diff --git a/vendor/sysinfo/md_doc/component.md b/vendor/sysinfo/md_doc/component.md new file mode 100644 index 000000000..618cace2f --- /dev/null +++ b/vendor/sysinfo/md_doc/component.md @@ -0,0 +1,16 @@ +Struct containing a component information (temperature and name for the moment). + +## Linux + +More information can be found at [kernel.org][k]. + +Note: these may not be present on virtual Linux systems, such as **Docker** +or **Windows Subsystem for Linux**. These hosts do not expose this information +and therefore `Component` elements may be missing or not as expected. + +[k]: https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface + +## Windows + +Please note that on Windows, you need to have Administrator priviledges to get this +information. diff --git a/vendor/sysinfo/md_doc/cpu.md b/vendor/sysinfo/md_doc/cpu.md new file mode 100644 index 000000000..6281e0980 --- /dev/null +++ b/vendor/sysinfo/md_doc/cpu.md @@ -0,0 +1 @@ +Struct containing information of a CPU. diff --git a/vendor/sysinfo/md_doc/disk.md b/vendor/sysinfo/md_doc/disk.md new file mode 100644 index 000000000..f94b7c1b8 --- /dev/null +++ b/vendor/sysinfo/md_doc/disk.md @@ -0,0 +1 @@ +Struct containing a disk information. diff --git a/vendor/sysinfo/md_doc/network_data.md b/vendor/sysinfo/md_doc/network_data.md new file mode 100644 index 000000000..070794948 --- /dev/null +++ b/vendor/sysinfo/md_doc/network_data.md @@ -0,0 +1 @@ +Contains network interface information. diff --git a/vendor/sysinfo/md_doc/networks.md b/vendor/sysinfo/md_doc/networks.md new file mode 100644 index 000000000..d8b6cc632 --- /dev/null +++ b/vendor/sysinfo/md_doc/networks.md @@ -0,0 +1,8 @@ +Networks interfaces. + +```no_run +use sysinfo::{NetworksExt, System, SystemExt}; + +let s = System::new_all(); +let networks = s.networks(); +``` diff --git a/vendor/sysinfo/md_doc/pid.md b/vendor/sysinfo/md_doc/pid.md new file mode 100644 index 000000000..d80e1ab9f --- /dev/null +++ b/vendor/sysinfo/md_doc/pid.md @@ -0,0 +1,20 @@ +Process id + +Can be used as an integer type by simple casting. For example: + +``` +use sysinfo::{PidExt, Pid}; + +// 0's type will be different depending on the platform! +let p = Pid::from(0); + +// For something more "general": +let p = Pid::from_u32(0); +let i: u32 = p.as_u32(); +``` + +On glibc systems this is a glibc [`pid_t`](https://www.gnu.org/software/libc/manual/html_node/Process-Identification.html). + +On Windows systems this is a [`usize` and represents a windows process identifier](https://docs.microsoft.com/en-us/windows/win32/procthread/process-handles-and-identifiers). + +On unsupported systems, this is also a `usize`. diff --git a/vendor/sysinfo/md_doc/process.md b/vendor/sysinfo/md_doc/process.md new file mode 100644 index 000000000..0b7f9f7f7 --- /dev/null +++ b/vendor/sysinfo/md_doc/process.md @@ -0,0 +1,10 @@ +Struct containing information of a process. + +## iOS + +This information cannot be retrieved on iOS due to sandboxing. + +## Apple app store + +If you are building a macOS Apple app store, it won't be able +to retrieve this information. diff --git a/vendor/sysinfo/md_doc/system.md b/vendor/sysinfo/md_doc/system.md new file mode 100644 index 000000000..faf50b915 --- /dev/null +++ b/vendor/sysinfo/md_doc/system.md @@ -0,0 +1 @@ +Structs containing system's information. |