Struct nvml_wrapper::struct_wrappers::device::PciInfo

pub struct PciInfo {
    pub bus: u32,
    pub bus_id: String,
    pub device: u32,
    pub domain: u32,
    pub pci_device_id: u32,
    pub pci_sub_system_id: Option<u32>,
}

PCI information about a GPU device.

Fields

bus: u32

The bus on which the device resides, 0 to 0xff.

bus_id: String

The PCI identifier.

device: u32

The device’s ID on the bus, 0 to 31.

domain: u32

The PCI domain on which the device’s bus resides, 0 to 0xffff.

pci_device_id: u32

The combined 16-bit device ID and 16-bit vendor ID.

pci_sub_system_id: Option<u32>

The 32-bit Sub System Device ID.

Will always be None if this PciInfo was obtained from NvLink.remote_pci_info(). NVIDIA says that the C field that this corresponds to “is not filled … and is indeterminate” when being returned from that specific call.

Will be Some in all other cases.

Implementations

impl PciInfo

pub fn try_from(
    struct_: nvmlPciInfo_t,
    sub_sys_id_present: bool
) -> Result<Self, NvmlError>

Try to create this struct from its C equivalent.

Passing false for sub_sys_id_present will set the pci_sub_system_id field to None. See the field docs for more.

Errors

• Utf8Error, if the string obtained from the C function is not valid Utf8

Trait Implementations

impl Clone for PciInfo

fn clone(&self) -> PciInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PciInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for PciInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<PciInfo> for PciInfo

fn eq(&self, other: &PciInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PciInfo) -> bool

This method tests for !=.

impl TryInto<nvmlPciInfo_st> for PciInfo

fn try_into(self) -> Result<nvmlPciInfo_t, Self::Error>

Convert this PciInfo back into its C equivalent.

Errors

• NulError, if a nul byte was found in the bus_id (shouldn’t occur?)
• StringTooLong, if bus_id.len() exceeded the length of NVML_DEVICE_PCI_BUS_ID_BUFFER_SIZE. This should (?) only be able to occur if the user modifies bus_id in some fashion. We return an error rather than panicking.

type Error = NvmlError

The type returned in the event of a conversion error.

impl Eq for PciInfo

impl StructuralEq for PciInfo

impl StructuralPartialEq for PciInfo