Struct PciLocation

pub struct PciLocation { /* private fields */ }

A location in the PCI hierarchy (i.e. a segment:bus:device.function tuple). The segment (also called domain in some contexts) is usually zero and unsupported by most enumerators.

Implementations

impl PciLocation

pub fn with_bdf(bus: u8, device: u8, function: u8) -> Result<Self, PciInfoError>

Creates a new PciLocation with an empty segment

pub fn with_bdf_u16(bdf: u16) -> Self

Creates a new PciLocation with an empty segment starting from a PCI location expressed as a 16bit integer

pub fn with_segment( segment: u16, bus: u8, device: u8, function: u8, ) -> Result<Self, PciInfoError>

Creates a new PciLocation also specifying the PCI segment

pub fn bus(&self) -> u8

Gets the bus component of the PCI location

pub fn bus_number(&self) -> PciBusNumber

Gets the bus component of the PCI location as a PciBusNumber

pub fn device(&self) -> u8

Gets the device component of the PCI location

pub fn function(&self) -> u8

Gets the function component of the PCI location

pub fn segment(&self) -> u16

Gets the segment (sometimes called PCI domain) component of the PCI location. This is zero on most systems as most systems have only one PCI segment/domain. Also most enumerators do not support correct deserializing of PCI segments, and systems with multiple PCI segments are rare enough to make testing very difficult.

Trait Implementations

impl Clone for PciLocation

fn clone(&self) -> PciLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PciLocation

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

Formats the value using the given formatter.

impl Display for PciLocation

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

Formats the value using the given formatter.

impl Hash for PciLocation

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PciLocation

fn cmp(&self, other: &PciLocation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PciLocation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PciLocation

fn partial_cmp(&self, other: &PciLocation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PciLocation

impl Eq for PciLocation

impl StructuralPartialEq for PciLocation