Struct nvml_wrapper::device::Device [−] [src]

pub struct Device<'nvml> { /* fields omitted */ }

Struct that represents a device on the system.

Obtain a Device with the various methods available to you on the NVML struct.

Rust's lifetimes will ensure that the NVML instance this Device was created from is not allowed to be shutdown until this Device is dropped, meaning you shouldn't have to worry about calls returning Uninitialized errors.

Methods

`impl<'nvml> Device<'nvml>`
[src]

`fn is_api_restricted(&self, api: Api) -> Result<bool>`

Gets the root/admin permissions for the target API.

Only root users are able to call functions belonging to restricted APIs. See the documentation for the RestrictedApi enum for a list of those functions.

Non-root users can be granted access to these APIs through use of .set_api_restricted().

Struct nvml_wrapper::device::Device [−] [src]

Methods

impl<'nvml> Device<'nvml>[src]

fn is_api_restricted(&self, api: Api) -> Result<bool>

fn applications_clock(&self, clock_type: Clock) -> Result<u32>

fn auto_boosted_clocks_enabled(&self) -> Result<AutoBoostClocksEnabledInfo>

fn bar1_memory_info(&self) -> Result<BAR1MemoryInfo>

fn board_id(&self) -> Result<u32>

fn brand(&self) -> Result<Brand>

fn bridge_chip_info(&self) -> Result<BridgeChipHierarchy>

fn clock(&self, clock_type: Clock, clock_id: ClockId) -> Result<u32>

fn max_customer_boost_clock(&self, clock_type: Clock) -> Result<u32>

fn compute_mode(&self) -> Result<ComputeMode>

fn clock_info(&self, clock_type: Clock) -> Result<u32>

fn running_compute_processes(&self) -> Result<Vec<ProcessInfo>>

fn running_compute_processes_count(&self) -> Result<u32>

fn current_pcie_link_gen(&self) -> Result<u32>

fn current_pcie_link_width(&self) -> Result<u32>

fn decoder_utilization(&self) -> Result<UtilizationInfo>

fn default_applications_clock(&self, clock_type: Clock) -> Result<u32>

fn detailed_ecc_errors( &self, error_type: MemoryError, counter_type: EccCounter) -> Result<EccErrorCounts>

fn is_display_active(&self) -> Result<bool>

fn is_display_connected(&self) -> Result<bool>

fn driver_model(&self) -> Result<DriverModelState>

fn is_ecc_enabled(&self) -> Result<EccModeState>

fn encoder_utilization(&self) -> Result<UtilizationInfo>

fn enforced_power_limit(&self) -> Result<u32>

fn fan_speed(&self) -> Result<u32>

fn gpu_operation_mode(&self) -> Result<OperationModeState>

fn running_graphics_processes(&self) -> Result<Vec<ProcessInfo>>

fn running_graphics_processes_count(&self) -> Result<u32>

fn index(&self) -> Result<u32>

fn config_checksum(&self) -> Result<u32>

fn info_rom_image_version(&self) -> Result<String>

fn info_rom_version(&self, object: InfoRom) -> Result<String>

fn max_clock_info(&self, clock_type: Clock) -> Result<u32>

fn max_pcie_link_gen(&self) -> Result<u32>

fn max_pcie_link_width(&self) -> Result<u32>

fn memory_error_counter( &self, error_type: MemoryError, counter_type: EccCounter, location: MemoryLocation) -> Result<u64>

fn memory_info(&self) -> Result<MemoryInfo>

fn is_multi_gpu_board(&self) -> Result<bool>

fn name(&self) -> Result<String>

fn pci_info(&self) -> Result<PciInfo>

fn pcie_replay_counter(&self) -> Result<u32>

fn pcie_throughput(&self, counter: PcieUtilCounter) -> Result<u32>

fn performance_state(&self) -> Result<PerformanceState>

fn power_management_limit_default(&self) -> Result<u32>

fn power_management_limit(&self) -> Result<u32>

fn power_management_limit_constraints( &self) -> Result<PowerManagementConstraints>

fn is_power_management_algo_active(&self) -> Result<bool>

fn power_state(&self) -> Result<PerformanceState>

fn power_usage(&self) -> Result<u32>

fn retired_pages(&self, cause: RetirementCause) -> Result<Vec<u64>>

fn are_pages_pending_retired(&self) -> Result<bool>

fn serial(&self) -> Result<String>

fn board_part_number(&self) -> Result<String>

fn current_throttle_reasons(&self) -> Result<ThrottleReasons>

fn supported_throttle_reasons(&self) -> Result<ThrottleReasons>

`impl<'nvml> Device<'nvml>`
[src]

`fn is_api_restricted(&self, api: Api) -> Result<bool>`

`fn applications_clock(&self, clock_type: Clock) -> Result<u32>`

`fn auto_boosted_clocks_enabled(&self) -> Result<AutoBoostClocksEnabledInfo>`

`fn bar1_memory_info(&self) -> Result<BAR1MemoryInfo>`

`fn board_id(&self) -> Result<u32>`

`fn brand(&self) -> Result<Brand>`

`fn bridge_chip_info(&self) -> Result<BridgeChipHierarchy>`

`fn clock(&self, clock_type: Clock, clock_id: ClockId) -> Result<u32>`

`fn max_customer_boost_clock(&self, clock_type: Clock) -> Result<u32>`

`fn compute_mode(&self) -> Result<ComputeMode>`

`fn clock_info(&self, clock_type: Clock) -> Result<u32>`

`fn running_compute_processes(&self) -> Result<Vec<ProcessInfo>>`

`fn running_compute_processes_count(&self) -> Result<u32>`

`fn current_pcie_link_gen(&self) -> Result<u32>`

`fn current_pcie_link_width(&self) -> Result<u32>`

`fn decoder_utilization(&self) -> Result<UtilizationInfo>`

`fn default_applications_clock(&self, clock_type: Clock) -> Result<u32>`

`fn detailed_ecc_errors( &self, error_type: MemoryError, counter_type: EccCounter ) -> Result<EccErrorCounts>`

`fn is_display_active(&self) -> Result<bool>`

`fn is_display_connected(&self) -> Result<bool>`

`fn driver_model(&self) -> Result<DriverModelState>`

`fn is_ecc_enabled(&self) -> Result<EccModeState>`

`fn encoder_utilization(&self) -> Result<UtilizationInfo>`

`fn enforced_power_limit(&self) -> Result<u32>`

`fn fan_speed(&self) -> Result<u32>`

`fn gpu_operation_mode(&self) -> Result<OperationModeState>`

`fn running_graphics_processes(&self) -> Result<Vec<ProcessInfo>>`

`fn running_graphics_processes_count(&self) -> Result<u32>`

`fn index(&self) -> Result<u32>`

`fn config_checksum(&self) -> Result<u32>`

`fn info_rom_image_version(&self) -> Result<String>`

`fn info_rom_version(&self, object: InfoRom) -> Result<String>`

`fn max_clock_info(&self, clock_type: Clock) -> Result<u32>`

`fn max_pcie_link_gen(&self) -> Result<u32>`

`fn max_pcie_link_width(&self) -> Result<u32>`

`fn memory_error_counter( &self, error_type: MemoryError, counter_type: EccCounter, location: MemoryLocation ) -> Result<u64>`

`fn memory_info(&self) -> Result<MemoryInfo>`

`fn is_multi_gpu_board(&self) -> Result<bool>`

`fn name(&self) -> Result<String>`

`fn pci_info(&self) -> Result<PciInfo>`

`fn pcie_replay_counter(&self) -> Result<u32>`

`fn pcie_throughput(&self, counter: PcieUtilCounter) -> Result<u32>`

`fn performance_state(&self) -> Result<PerformanceState>`

`fn power_management_limit_default(&self) -> Result<u32>`

`fn power_management_limit(&self) -> Result<u32>`

`fn power_management_limit_constraints( &self ) -> Result<PowerManagementConstraints>`

`fn is_power_management_algo_active(&self) -> Result<bool>`

`fn power_state(&self) -> Result<PerformanceState>`

`fn power_usage(&self) -> Result<u32>`

`fn retired_pages(&self, cause: RetirementCause) -> Result<Vec<u64>>`

`fn are_pages_pending_retired(&self) -> Result<bool>`

`fn serial(&self) -> Result<String>`

`fn board_part_number(&self) -> Result<String>`

`fn current_throttle_reasons(&self) -> Result<ThrottleReasons>`

`fn supported_throttle_reasons(&self) -> Result<ThrottleReasons>`