Struct hwloc2::MemBindPolicy

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

Implementations

impl MemBindPolicy

pub const MEMBIND_DEFAULT: MemBindPolicy

Reset the memory allocation policy to the system default. Depending on the operating system, this may correspond to MEMBIND_FIRSTTOUCH (Linux), or MEMBIND_BIND (AIX, HP-UX, OSF, Solaris, Windows).

pub const MEMBIND_FIRSTTOUCH: MemBindPolicy

Allocate memory but do not immediately bind it to a specific locality. Instead, each page in the allocation is bound only when it is first touched. Pages are individually bound to the local NUMA node of the first thread that touches it. If there is not enough memory on the node, allocation may be done in the specified cpuset before allocating on other nodes.

pub const MEMBIND_BIND: MemBindPolicy

Allocate memory on the specified nodes.

pub const MEMBIND_INTERLEAVE: MemBindPolicy

Allocate memory on the given nodes in an interleaved / round-robin manner. The precise layout of the memory across multiple NUMA nodes is OS/system specific. Interleaving can be useful when threads distributed across the specified NUMA nodes will all be accessing the whole memory range concurrently, since the interleave will then balance the memory references.

pub const MEMBIND_NEXTTOUCH: MemBindPolicy

For each page bound with this policy, by next time it is touched (and next time only), it is moved from its current location to the local NUMA node of the thread where the memory reference occurred (if it needs to be moved at all).

pub const MEMBIND_MIXED: MemBindPolicy

Returned by get_membind() functions when multiple threads or parts of a memory area have differing memory binding policies.

pub const fn empty() -> MemBindPolicy

Returns an empty set of flags

pub const fn all() -> MemBindPolicy

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<MemBindPolicy>

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) -> MemBindPolicy

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

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

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: MemBindPolicy) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for MemBindPolicy

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

Formats the value using the given formatter.

impl BitAnd<MemBindPolicy> for MemBindPolicy

type Output = MemBindPolicy

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<MemBindPolicy> for MemBindPolicy

fn bitand_assign(&mut self, other: MemBindPolicy)

Disables all flags disabled in the set.

impl BitOr<MemBindPolicy> for MemBindPolicy

type Output = MemBindPolicy

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<MemBindPolicy> for MemBindPolicy

fn bitor_assign(&mut self, other: MemBindPolicy)

Adds the set of flags.

impl BitXor<MemBindPolicy> for MemBindPolicy

type Output = MemBindPolicy

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<MemBindPolicy> for MemBindPolicy

fn bitxor_assign(&mut self, other: MemBindPolicy)

Toggles the set of flags.

impl Clone for MemBindPolicy

fn clone(&self) -> MemBindPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MemBindPolicy

impl Debug for MemBindPolicy

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

Formats the value using the given formatter.

impl Eq for MemBindPolicy

impl Extend<MemBindPolicy> for MemBindPolicy

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

Extends a collection with the contents of an iterator.

impl FromIterator<MemBindPolicy> for MemBindPolicy

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

Creates a value from an iterator.

impl Hash for MemBindPolicy

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 MemBindPolicy

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

Formats the value using the given formatter.

impl Not for MemBindPolicy

type Output = MemBindPolicy

The resulting type after applying the ! operator.

fn not(self) -> MemBindPolicy

Returns the complement of this set of flags.

impl Octal for MemBindPolicy

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

Formats the value using the given formatter.

impl Ord for MemBindPolicy

fn cmp(&self, other: &MemBindPolicy) -> 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<MemBindPolicy> for MemBindPolicy

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

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

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

This method tests for !=.

impl PartialOrd<MemBindPolicy> for MemBindPolicy

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for MemBindPolicy

impl StructuralPartialEq for MemBindPolicy

impl Sub<MemBindPolicy> for MemBindPolicy

type Output = MemBindPolicy

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<MemBindPolicy> for MemBindPolicy

fn sub_assign(&mut self, other: MemBindPolicy)

Disables all flags enabled in the set.

impl UpperHex for MemBindPolicy

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

Formats the value using the given formatter.