Struct hwlocality::memory::binding::MemoryBindingFlags

pub struct MemoryBindingFlags(/* private fields */);

Memory binding flags.

These bit flags can be used to refine the binding policy. All flags can be OR’ed together with the exception of the binding target flags ASSUME_SINGLE_THREAD, THREAD and PROCESS, of which at most one must be specified. The most portable option is ASSUME_SINGLE_THREAD, when it is applicable.

When using one of the methods that target a process, you must use exactly one of these flags. The most portable option is ASSUME_SINGLE_THREAD, when it is applicable. These flags must not be used with any other method.

Individual memory binding methods may not support all of these flags. Please check the documentation of the memory binding method that you are calling for more information.

Implementations

impl MemoryBindingFlags

pub const ASSUME_SINGLE_THREAD: Self = _

Assume that the target process is single threaded

This lets hwloc pick between thread and process binding for increased portability.

This is mutually exclusive with PROCESS and THREAD.

pub const PROCESS: Self = _

Apply command to all threads of the specified process

This is mutually exclusive with ASSUME_SINGLE_THREAD and THREAD.

pub const THREAD: Self = _

Apply command to the current thread of the current process

This is mutually exclusive with ASSUME_SINGLE_THREAD and PROCESS.

pub const STRICT: Self = _

Request strict binding from the OS

If this flag is set, a binding method will fail if the binding can not be guaranteed or completely enforced. Otherwise, hwloc will attempt to achieve an approximation of the requested binding (e.g. targeting more or less threads and NUMA nodes).

This flag has slightly different meanings depending on which method it is used with.

pub const MIGRATE: Self = _

Migrate existing allocated memory

If the memory cannot be migrated and the STRICT flag is set, an error will be returned.

This flag is only meaningful on operations that bind memory.

Requires MemoryBindingSupport::migrate_flag().

pub const NO_CPU_BINDING: Self = _

Avoid any effect on CPU binding

On some operating systems, some underlying memory binding methods also bind the application to the corresponding CPU(s). Using this flag will cause hwloc to avoid using OS functions that could potentially affect CPU bindings.

Note, however, that using this flag may reduce hwloc’s overall memory binding support.

impl MemoryBindingFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> hwloc_membind_flags_t

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: hwloc_membind_flags_t) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: hwloc_membind_flags_t) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: hwloc_membind_flags_t) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MemoryBindingFlags

pub const fn iter(&self) -> Iter<MemoryBindingFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MemoryBindingFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Arbitrary for MemoryBindingFlags

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<Subsequence<MemoryBindingFlags>, fn(_: Vec<MemoryBindingFlags>) -> MemoryBindingFlags>

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 Binary for MemoryBindingFlags

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

Formats the value using the given formatter.

impl BitAnd for MemoryBindingFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = MemoryBindingFlags

The resulting type after applying the & operator.

impl BitAndAssign for MemoryBindingFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MemoryBindingFlags

fn bitor(self, other: MemoryBindingFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MemoryBindingFlags

The resulting type after applying the | operator.

impl BitOrAssign for MemoryBindingFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MemoryBindingFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MemoryBindingFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for MemoryBindingFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MemoryBindingFlags

fn clone(&self) -> MemoryBindingFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryBindingFlags

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

Formats the value using the given formatter.

impl Extend<MemoryBindingFlags> for MemoryBindingFlags

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

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MemoryBindingFlags

const FLAGS: &'static [Flag<MemoryBindingFlags>] = _

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> hwloc_membind_flags_t

Get the underlying bits value.

fn from_bits_retain(bits: hwloc_membind_flags_t) -> MemoryBindingFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl<OwnedSet: OwnedSpecializedBitmap> From<MemoryBindingFlags> for MemoryBindingError<OwnedSet>

fn from(value: MemoryBindingFlags) -> Self

Converts to this type from the input type.

impl FromIterator<MemoryBindingFlags> for MemoryBindingFlags

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

The bitwise or (|) of the bits in each flags value.

impl Hash for MemoryBindingFlags

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 IntoIterator for MemoryBindingFlags

type Item = MemoryBindingFlags

The type of the elements being iterated over.

type IntoIter = Iter<MemoryBindingFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MemoryBindingFlags

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

Formats the value using the given formatter.

impl Not for MemoryBindingFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MemoryBindingFlags

The resulting type after applying the ! operator.

impl Octal for MemoryBindingFlags

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

Formats the value using the given formatter.

impl PartialEq for MemoryBindingFlags

fn eq(&self, other: &MemoryBindingFlags) -> 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 PublicFlags for MemoryBindingFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for MemoryBindingFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MemoryBindingFlags

The resulting type after applying the - operator.

impl SubAssign for MemoryBindingFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MemoryBindingFlags

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

Formats the value using the given formatter.

impl Copy for MemoryBindingFlags

impl Eq for MemoryBindingFlags

impl StructuralPartialEq for MemoryBindingFlags