Crate sysutil

Linux system information library

This library is ment to be used only in linux systems. It is possible to write code using it on other systems, but it will not allow to run the code, panicking before execution

Installation

Run the following command in your terminal

cargo add sysutil

Importation

Add in your code:

use sysutil;

---

GPU's related functions have been tested only on AMD Radeon 7000 series, any other GPU model is not "officially supported"

Structs

• Backlight
  Holds information about backlight
• Battery
  Contains capacity and current status of battery
• Bios
  Contains information relative to the installed bios
• ByteSize
  Bytes size data structure implementing methods to convert in various size orders The methods allow the convertion in the various size orders, both in base 1000 and base 1024
• CPU
  Encloses all CPU-related data available in the library
• ClockSource
  Contains currently active clock source and the available ones
• CpuFrequency
  Contains cpu frequencies, both average and processor wise
• CpuInfo
  Contains base information relative to the CPU
• CpuUsage
  Contains the average CPU usage and the discrete usage for each processor
• Frequency
  Frequency data structure implements direct conversion for frequencies in various size orders
• GpuMetrics
  Encloses gpu metrics parameters
• Motherboard
  Contains information relative to the motherboard and the installed bios
• NetworkRate
  Contains total download and upload newtwork rate (in bytes)
• NetworkRoute
  Represents a network route and its type, containing local address+port and remote address+port
• NvmeDevice
  Contains NVME device information
• ProcessorFrequency
  Contains processor id and its frequency
• ProcessorUsage
  Encloses the different parameters relative to processor usage
• RamSize
  Contains total ram size, both in GB (1000^3 bytes) and GiB (1024^3 bytes)
• SchedulerPolicy
  Contains scheduler information relative to a processor in the system
• StorageDevice
  Contains information relative to a storage device in the system
• StoragePartition
  Encloses device name, size and startpoint relative to a partition
• TemperatureSensor
  Contains temperature sensor’s name and recorded temperature
• VramSize
  Contains total gpu’s vram size, both in GB (1000^3 bytes) and GiB (1024^3 bytes)

Enums

• BatteryStatus
  Represents the current status of battery
• RouteType
  Different route types

Functions

• batteryInfo
  Returns battery current status and capacity as specified in Battery struct, returns None if it’s not possible to retrieve data
• biosInfo
  Returns information about the currently installed BIOS
• clockSource
  Returns the currently active clock source and the different ones available, enclosed in ClockSource struct
• cpuFrequency
  Returns cpu frequency, both average and processor wise
• cpuInfo
  Returns CPU base information, enclosed in the CpuInfo data structure
• cpuUsage
  Returns CPU usage, both average and processor-wise, each value is in percentage
• exportJson
• getBacklight
  Returns the current backlight brightness and the maximum possible value or None if it’s not possible to retrieve data
• gpuMetrics
  Returns metrics parameters from the amdgpu driver
• gpuUsage
  returns current GPU usage in percentage, returns None if it’s not possible to retrieve data
• motherboardInfo
  Returns information about the motherboard
• networkRate
  Returns current network rate (downlaod and upload), expressed in bytes
• networkRoutes
  Returns a list of each internal network route
• nvmeDevices
  Returns a vector containing all NVME devices found in the system
• ramSize
  Returns RAM size using the RamSize data structure
• ramUsage
  Returns current RAM usage in percentage
• schedulerInfo
  Returns scheduler information for each processor
• storageDevices
  Returns a vector containing all storage devices (NVME excluded) in the system
• temperatureSensors
  Returns every temperature sensor in the system, using the TemperatureSensor struct
• vramSize
  Returns gpu’s vram size as specified in VramSize struct, returns None if it’s not possible to retrieve data
• vramUsage
  Returns gpu’s vram usage in percentage, returns None if it’s not possible to retrieve data