Enum hwlocality::topology::builder::TypeFilter

#[repr(i32)]
pub enum TypeFilter {
    KeepAll = 0,
    KeepNone = 1,
    KeepStructure = 2,
    KeepImportant = 3,
}

Type filtering flags

By default…

• Most objects are kept (KeepAll)
• Instruction caches, I/O and Misc objects are ignored (KeepNone).
• Die and Group levels are ignored unless they bring structure (KeepStructure).

Note that group objects are also ignored individually (without the entire level) when they do not bring structure.

Variants

KeepAll = 0

Keep all objects of this type

Cannot be set for ObjectType::Group (groups are designed only to add more structure to the topology).

KeepNone = 1

Ignore all objects of this type

The bottom-level type ObjectType::PU, the ObjectType::NUMANode type, and the top-level type ObjectType::Machine may not be ignored.

KeepStructure = 2

Only ignore objects if their entire level does not bring any structure

Keep the entire level of objects if at least one of these objects adds structure to the topology. An object brings structure when it has multiple children and it is not the only child of its parent.

If all objects in the level are the only child of their parent, and if none of them has multiple children, the entire level is removed.

Cannot be set for I/O and Misc objects since the topology structure does not matter there.

KeepImportant = 3

Only keep likely-important objects of the given type.

This is only useful for I/O object types.

For ObjectType::PCIDevice and ObjectType::OSDevice, it means that only objects of major/common kinds are kept (storage, network, OpenFabrics, CUDA, OpenCL, RSMI, NVML, and displays). Also, only OS devices directly attached on PCI (e.g. no USB) are reported.

For ObjectType::Bridge, it means that bridges are kept only if they have children.

This flag is equivalent to KeepAll for Normal, Memory and Misc types since they are likely important.

Trait Implementations

impl Arbitrary for TypeFilter

Available on crate feature proptest only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<Range<usize>, fn(_: usize) -> TypeFilter>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for TypeFilter

fn clone(&self) -> TypeFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeFilter

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

Formats the value using the given formatter.

impl From<TypeFilter> for i32

fn from(enum_value: TypeFilter) -> Self

Converts to this type from the input type.

impl Hash for TypeFilter

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 PartialEq for TypeFilter

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

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

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

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

impl Sequence for TypeFilter

const CARDINALITY: usize = 4usize

Number of values of type Self.

fn next(&self) -> Option<Self>

Returns value following *self or None if this was the end.

fn previous(&self) -> Option<Self>

Returns value preceding *self or None if this was the beginning.

fn first() -> Option<Self>

Returns the first value of type Self.

fn last() -> Option<Self>

Returns the last value of type Self.

impl TryFrom<i32> for TypeFilter

type Error = TryFromPrimitiveError<TypeFilter>

The type returned in the event of a conversion error.

fn try_from(number: i32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for TypeFilter

type Primitive = i32

type Error = TryFromPrimitiveError<TypeFilter>

const NAME: &'static str = "TypeFilter"

fn try_from_primitive( number: Self::Primitive ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for TypeFilter

impl Eq for TypeFilter

impl StructuralPartialEq for TypeFilter