Struct hwloc2::CpuBindFlags

#[repr(C)]pub struct CpuBindFlags { /* fields omitted */ }

Process/Thread binding flags.

These bit flags can be used to refine the binding policy.

The default (Process) is to bind the current process, assumed to be single-threaded, in a non-strict way. This is the most portable way to bind as all operating systems usually provide it.

Note: Not all systems support all kinds of binding.

The following flags (constants) are available:

• CPUBIND_PROCESS: Bind all threads of the current (possibly) multithreaded process.
• CPUBIND_THREAD: Bind current thread of current process.
• CPUBIND_STRICT: Request for strict binding from the OS.
• CPUBIND_NO_MEMBIND: Avoid any effect on memory binding.

Implementations

impl CpuBindFlags

pub const CPUBIND_PROCESS: CpuBindFlags

Bind all threads of the current (possibly) multithreaded process.

pub const CPUBIND_THREAD: CpuBindFlags

Bind current thread of current process.

pub const CPUBIND_STRICT: CpuBindFlags

Request for strict binding from the OS.

pub const CPUBIND_NO_MEMBIND: CpuBindFlags

Avoid any effect on memory binding.

pub const fn empty() -> CpuBindFlags

Returns an empty set of flags

pub const fn all() -> CpuBindFlags

Returns the set containing all flags.

pub const fn bits(&self) -> i32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: i32) -> Option<CpuBindFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: i32) -> CpuBindFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: i32) -> CpuBindFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: CpuBindFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: CpuBindFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: CpuBindFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: CpuBindFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: CpuBindFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: CpuBindFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for CpuBindFlags

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

Formats the value using the given formatter.

impl BitAnd<CpuBindFlags> for CpuBindFlags

type Output = CpuBindFlags

The resulting type after applying the & operator.

fn bitand(self, other: CpuBindFlags) -> CpuBindFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<CpuBindFlags> for CpuBindFlags

fn bitand_assign(&mut self, other: CpuBindFlags)

Disables all flags disabled in the set.

impl BitOr<CpuBindFlags> for CpuBindFlags

type Output = CpuBindFlags

The resulting type after applying the | operator.

fn bitor(self, other: CpuBindFlags) -> CpuBindFlags

Returns the union of the two sets of flags.

impl BitOrAssign<CpuBindFlags> for CpuBindFlags

fn bitor_assign(&mut self, other: CpuBindFlags)

Adds the set of flags.

impl BitXor<CpuBindFlags> for CpuBindFlags

type Output = CpuBindFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: CpuBindFlags) -> CpuBindFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<CpuBindFlags> for CpuBindFlags

fn bitxor_assign(&mut self, other: CpuBindFlags)

Toggles the set of flags.

impl Clone for CpuBindFlags

fn clone(&self) -> CpuBindFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CpuBindFlags

impl Debug for CpuBindFlags

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

Formats the value using the given formatter.

impl Eq for CpuBindFlags

impl Extend<CpuBindFlags> for CpuBindFlags

fn extend<T: IntoIterator<Item = CpuBindFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<CpuBindFlags> for CpuBindFlags

fn from_iter<T: IntoIterator<Item = CpuBindFlags>>(iterator: T) -> CpuBindFlags

Creates a value from an iterator.

impl Hash for CpuBindFlags

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 LowerHex for CpuBindFlags

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

Formats the value using the given formatter.

impl Not for CpuBindFlags

type Output = CpuBindFlags

The resulting type after applying the ! operator.

fn not(self) -> CpuBindFlags

Returns the complement of this set of flags.

impl Octal for CpuBindFlags

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

Formats the value using the given formatter.

impl Ord for CpuBindFlags

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<CpuBindFlags> for CpuBindFlags

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

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

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

This method tests for !=.

impl PartialOrd<CpuBindFlags> for CpuBindFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for CpuBindFlags

impl StructuralPartialEq for CpuBindFlags

impl Sub<CpuBindFlags> for CpuBindFlags

type Output = CpuBindFlags

The resulting type after applying the - operator.

fn sub(self, other: CpuBindFlags) -> CpuBindFlags

Returns the set difference of the two sets of flags.

impl SubAssign<CpuBindFlags> for CpuBindFlags

fn sub_assign(&mut self, other: CpuBindFlags)

Disables all flags enabled in the set.

impl UpperHex for CpuBindFlags

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

Formats the value using the given formatter.