Struct VgpuType

Source

pub struct VgpuType<'dev> { /* private fields */ }

Implementations§

Source §

impl<'dev> VgpuType<'dev>

Source

pub fn new(device: &'dev Device<'_>, id: nvmlVgpuTypeId_t) -> Self

Create a new vGPU type wrapper.

You probably don’t need to use this yourself, but rather through Device::vgpu_supported_types and Device::vgpu_creatable_types.

Source

pub fn device(&self) -> &'dev Device<'_>

Access the Device this struct belongs to.

Source

pub fn class_name(&self) -> Result<String, NvmlError>

Retrieve the class of the vGPU type.

§Errors

Uninitialized, if the library has not been successfully initialized
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device support

Kepler or newer fully supported devices.

Source

pub fn license(&self) -> Result<String, NvmlError>

Retrieve license requirements for a vGPU type.

The license type and version required to run the specified vGPU type is returned as an alphanumeric string, in the form “<license name>,<version>”, for example “GRID-Virtual-PC,2.0”. If a vGPU is runnable with* more than one type of license, the licenses are delimited by a semicolon, for example “GRID-Virtual-PC,2.0;GRID-Virtual-WS,2.0;GRID-Virtual-WS-Ext,2.0”.

§Errors

Uninitialized, if the library has not been successfully initialized
InsufficientSize, if the passed-in size is 0 (must be > 0)
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device support

Kepler or newer fully supported devices.

Source

pub fn name(&self) -> Result<String, NvmlError>

Retrieve the name of the vGPU type.

The name is an alphanumeric string that denotes a particular vGPU, e.g. GRID M60-2Q.

§Errors

Uninitialized, if the library has not been successfully initialized
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device support

Kepler or newer fully supported devices.

Source

pub fn capabilities( &self, capability: nvmlVgpuCapability_t, ) -> Result<bool, NvmlError>

Retrieve the requested capability for a given vGPU type. Refer to the nvmlVgpuCapability_t structure for the specific capabilities that can be queried.

§Errors

Uninitialized, if the library has not been successfully initialized
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device Support

Maxwell or newer fully supported devices.

Source

pub fn device_id(&self) -> Result<(u64, u64), NvmlError>

Retrieve the device ID of the vGPU type.

§Errors

Uninitialized, if the library has not been successfully initialized
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device Support

Kepler or newer fully supported devices.

Source

pub fn frame_rate_limit(&self) -> Result<u32, NvmlError>

Retrieve the static frame rate limit value of the vGPU type.

§Errors

Uninitialized, if the library has not been successfully initialized
NotSupported, if frame rate limiter is turned off for the vGPU type
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device Support

Kepler or newer fully supported devices.

Source

pub fn framebuffer_size(&self) -> Result<u64, NvmlError>

Retrieve the vGPU framebuffer size in bytes.

§Errors

Uninitialized, if the library has not been successfully initialized
InvalidArg, if this Device is invalid
Unknown, on any unexpected error

§Device Support

Kepler or newer fully supported devices.

Source

pub fn instance_profile_id(&self) -> Result<u32, NvmlError>

Retrieve the GPU Instance Profile ID for the vGPU type. The API will return a valid GPU Instance Profile ID for the MIG capable vGPU types, else crate::ffi::bindings::INVALID_GPU_INSTANCE_PROFILE_ID is returned.