Struct swiss_army_knife::bit_set::BitSet

#[repr(transparent)]
pub struct BitSet<BSA: BitSetAware>(_, _);

Represents a BitSet suitable for use with various Linux /sys files and NUMA syscalls.

Internally uses usize to match what Linux uses.

Implementations

impl<BSA: BitSetAware> BitSet<BSA>

pub fn new() -> Self

Creates a new empty bit set (all bits are initially zero) of the maximum possible size.

pub fn for_one(element: BSA) -> Self

Creates a new bit set containing just element.

pub fn empty_but_same_capacity(&self) -> Self

Creates an empty new instance of the same capacity as this one.

pub fn with_capacity_in_words(size_in_words: usize) -> Self

Creates a new empty bit set (all bits are initially zero).

Panics if size_in_words exceeds that needed to represent BSA::LinuxMaximum.

pub fn empty() -> Self

Creates a new empty bit set with no bits at all.

pub fn parse_linux_list_string(
    linux_list_string: &[u8]
) -> Result<BitSet<BSA>, ListParseError>

Parses a Linux list string used for cpu sets, core masks and NUMA nodes such as “2,4-31,32-63” and “1,2,10-20,100-2000:2/25” (see https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html for an awful description of this mad syntax).

Returns a BitSet with the zero-based indices found in the string. For example, “2,4-31,32-63” would return a set with all values between 0 to 63 except 0, 1 and 3.

linux_list_string does not have a terminating line feed (LF).

pub fn cap_retaining_lowest_values(&mut self, maximum_length: usize)

Removes the highest values from the set.

pub fn iterate<'a>(&'a self) -> BitSetIterator<'a, BSA>

Iterate.

pub fn iterate_infinitely<'a>(&'a self) -> InfiniteBitSetIterator<'a, BSA>

Iterate infinitely.

pub fn iterate_including_empty<'a>(
    &'a self
) -> BitSetIncludingEmptyIterator<'a, BSA>

Iterate.

pub fn capacity(&self) -> usize

Capacity assuming one byte per HyperThread represented.

Suitable for use as the size of a Vec, say, which will hold HyperThread items, one per HyperThread.

pub fn is_empty(&self) -> bool

Are no bits set?

This operation is a little expensive, but less expensive than self.len().

pub fn is_full(&self) -> bool

Are all bits set?

This operation is a little expensive, but less expensive than self.len().

pub fn is_shorter_than_or_equal_to(&self, maximum_length: usize) -> bool

Is this longer than maximum_length?

More efficient than calling self.len() <= maximum_length.

pub fn is_longer_than(&self, maximum_length: usize) -> bool

Is this longer than maximum_length?

More efficient than calling self.len() > maximum_length.

pub fn len(&self) -> usize

Number of bits set.

This operation is relatively expensive.

For an emptiness check, prefer self.is_empty() which is slightly less expensive.

pub fn len_if_full(&self) -> Option<usize>

Number of bits set if all bits are set.

pub fn add(&mut self, element: BSA)

Adds.

pub unsafe fn add_unchecked(&mut self, element: BSA)

Adds, without checking capacity.

pub fn contains(&self, element: BSA) -> bool

Does this bit set contain element?

pub fn remove(&mut self, element: BSA)

Removes.

pub fn pop_first(&mut self) -> BSA

Pops first element.

pub fn shrink_to_fit(&mut self)

Removes top bits that are zero and tries to shrink underlying storage.

Use only if intending to store a BitSet in memory for a long time.

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

Keeps only bits in both sets.

If sets are of different lengths, the missing bits are assumed to be zero.

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

Removes bits in other.

Trait Implementations

impl<BSA: Clone + BitSetAware> Clone for BitSet<BSA>

fn clone(&self) -> BitSet<BSA>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BSA: Debug + BitSetAware> Debug for BitSet<BSA>

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

Formats the value using the given formatter.

impl<BSA: BitSetAware> Default for BitSet<BSA>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, BSA: BitSetAware> Deserialize<'de> for BitSet<BSA>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<BSA: Hash + BitSetAware> Hash for BitSet<BSA>

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<BSA: Ord + BitSetAware> Ord for BitSet<BSA>

fn cmp(&self, other: &BitSet<BSA>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<BSA: PartialEq + BitSetAware> PartialEq<BitSet<BSA>> for BitSet<BSA>

fn eq(&self, other: &BitSet<BSA>) -> bool

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

fn ne(&self, other: &BitSet<BSA>) -> bool

This method tests for !=.

impl<BSA: PartialOrd + BitSetAware> PartialOrd<BitSet<BSA>> for BitSet<BSA>

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

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

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

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

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

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

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

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

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

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

impl<BSA: BitSetAware> Serialize for BitSet<BSA>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<BSA: Eq + BitSetAware> Eq for BitSet<BSA>

impl<BSA: BitSetAware> StructuralEq for BitSet<BSA>

impl<BSA: BitSetAware> StructuralPartialEq for BitSet<BSA>