Struct ProgrammerStateSet

pub struct ProgrammerStateSet { /* private fields */ }

A set of ProgrammerState values, efficiently implemented as a bitfield.

It is internally implemented as a single u16 integer value. The N-th least significant bit of the value is set to 1 if the N-th variant is present in the set, and 0 otherwise.

Representation

It is guaranteed that the layout and ABI of a ProgrammerStateSet is exactly the same of a u16. This is true regardless of any #[repr(..)] attribute set on ProgrammerState.

Invariant

Only the last 9 (the number of variants in ProgrammerState) may be non-zero. That is, the value of bits that do not correspond to an existing variant must always be set to 0. All the intrinsic methods will respect this invariant, but please take this into account when manipulating the state of the set via unsafe or using it in FFI.

Implementations

impl ProgrammerStateSet

pub const fn new() -> Self

Creates a new empty ProgrammerStateSet.

pub fn from<T: IntoIterator<Item = I>, I: Borrow<ProgrammerState>>( iter: T, ) -> Self

Creates a new ProgrammerStateSet from an iterator that yields any borrowed type of ProgrammerState variants. Duplicated values are ignored.

pub const fn from_slice(slice: &[ProgrammerState]) -> Self

Creates a new ProgrammerStateSet from a slice of the variants of the set. Can be used in const contexts.

pub const fn from_array<const N: usize>(array: [ProgrammerState; N]) -> Self

Creates a new ProgrammerStateSet from an array of the variants of the set. Can be used in const contexts.

pub const fn empty() -> Self

Creates a new empty ProgrammerStateSet.

pub const fn all() -> Self

Creates a new ProgrammerStateSet that contains all the variants of ProgrammerState.

pub const fn is_empty(&self) -> bool

Returns true if the set is empty.

pub const fn is_all(&self) -> bool

Returns true if the set contains all 9 possible variants of ProgrammerState.

pub const fn len(&self) -> usize

Returns the number of variants of ProgrammerState present in the set.

pub fn contains<T: Borrow<ProgrammerState>>(&self, item: T) -> bool

Returns true if the set contains the given variant. The variant can be specified by any borrow of ProgrammerState.

pub fn contains_const(&self, item: &ProgrammerState) -> bool

Returns true if the set contains the given variant. This version of contains can be used in const contexts, but does not allow using a borrowed type of ProgrammerState.

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

Creates a new ProgrammerStateSet that contains all the variants that are in either self or other, leaving both input sets unchanged.

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

Creates a new ProgrammerStateSet that contains all the variants that are in both self and other, leaving both input sets unchanged.

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

Creates a new ProgrammerStateSet that contains all the variants that are in self but not in other, leaving both input sets unchanged.

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

Creates a new ProgrammerStateSet that contains all the variants that are in either self or other, but not in both, leaving both input sets unchanged.

pub const fn complement(&self) -> Self

Creates a new ProgrammerStateSet that contains all the variants that are not in self, leaving the input set unchanged.

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

Returns true if self is a subset of other. That is, if self contains all the items that exist in other.

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

Returns true if self is a superset of other. That is, if other contains all the items that exist in self.

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

Returns true if self has no elements in common with other.

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

Returns true if self and other are complementary sets. Two sets are complementary if their union contains all variants and their intersection is empty.

pub fn insert<T: Borrow<ProgrammerState>>(&mut self, item: T)

Inserts a variant into the set. The variant can be specified by any borrow of ProgrammerState.

pub fn remove<T: Borrow<ProgrammerState>>(&mut self, item: T)

Removes a variant from the set. The variant can be specified by any borrow of ProgrammerState.

pub const fn insert_const(&mut self, item: &ProgrammerState)

Inserts a variant into the set. This version of insert can be used in const contexts, but does not allow using a borrowed type of ProgrammerState.

pub const fn remove_const(&mut self, item: &ProgrammerState)

Removes a variant from the set. This version of remove can be used in const contexts, but does not allow using a borrowed type of ProgrammerState.

pub const fn iter(&self) -> ProgrammerStateSetSetIter

Returns an iterator over the variants of ProgrammerState contained in the set. Variants are yielded in the order in which they appear in the definition of ProgrammerState, regardless of insertion order.

pub const fn to_repr(&self) -> u16

Returns the integer representation of the set as a bitset. The N-th variant of ProgrammerState corresponds to the N-th least significative bit of the integer.

pub const fn from_repr(repr: u16) -> Option<Self>

Creates a new ProgrammerStateSet from an integer interpreted as a bitset. The N-th variant of ProgrammerState corresponds to the N-th least significative bit of the integer.

Returns None if the integer is not a valid bitset representation of the set (i.e, a bit that does not correspond to any variant of ProgrammerState is set to 1.).

pub const fn is_valid_repr(repr: u16) -> bool

Checks whether the provided value is a valid representation for a ProgrammerStateSet.

pub const unsafe fn from_repr_unchecked(repr: u16) -> Self

Creates a new ProgrammerStateSet from an integer interpreted as a bitset. The N-th variant of ProgrammerState corresponds to the N-th least significative bit of the integer.

Safety

The integer must be a valid bitset representation of the set, but the invariant that bits that do not correspond to a variant of ProgrammerState is not checked, so must be guaranteed by the calling code.

It is undefined behavior to pass an invalid value. Methods and iterators obtained from the generated set might exhibit incorrect behavior, including possible panics.

Safe alternatives

Note the from_repr_masked method that silently discards invalid bits at the cost of a (cheap) single bit-wise and operation.

Also the from_repr_discarded method that returns the discarded bits alongide the new set instance (where those bits are safely masked out). This can be useful as an error hanlding mechanism.

pub const unsafe fn from_repr_masked(repr: u16) -> Self

Creates a new ProgrammerStateSet from an integer interpreted as a bitset, silently discarding invalid bits. The N-th variant of ProgrammerState corresponds to the N-th least significative bit of the integer.

If the provided repr has bits that do not map to a variant of the original enum set to one, they are masked out and ignored to uphold the bitset integrity invariant.

pub const unsafe fn from_repr_discarded(repr: u16) -> (Self, u16)

Creates a new ProgrammerStateSet from an integer interpreted as a bitset, discarding invalid bits. Returns the created set and an integer where only the discarded bits are set to 1. The N-th variant of ProgrammerState corresponds to the N-th least significative bit of the integer.

If the provided repr has bits that do not map to a variant of the original enum set to one, they are masked out to uphold the bitset integrity invariant. The discarded bits that were set are returned as the second member of the tuple.

pub fn collect<B: FromIterator<ProgrammerState>>(&self) -> B

Collects the values present in the set into any value that can be formed by an iterator of ProgrammerState. That is, any value that implements FromIterator<ProgrammerState`>.

Trait Implementations

impl Add<&ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the + operator.

fn add(self, rhs: &ProgrammerState) -> Self

Performs the + operation.

impl Add<&ProgrammerStateSet> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the + operator.

fn add(self, rhs: &Self) -> Self

Performs the + operation.

impl Add<ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the + operator.

fn add(self, rhs: ProgrammerState) -> Self

Performs the + operation.

impl Add for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign<&ProgrammerState> for ProgrammerStateSet

fn add_assign(&mut self, rhs: &ProgrammerState)

Performs the += operation.

impl AddAssign<&ProgrammerStateSet> for ProgrammerStateSet

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl AddAssign<ProgrammerState> for ProgrammerStateSet

fn add_assign(&mut self, rhs: ProgrammerState)

Performs the += operation.

impl AddAssign for ProgrammerStateSet

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd<&ProgrammerStateSet> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the & operator.

fn bitand(self, rhs: &Self) -> Self

Performs the & operation.

impl BitAnd for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<&ProgrammerStateSet> for ProgrammerStateSet

fn bitand_assign(&mut self, rhs: &Self)

Performs the &= operation.

impl BitAndAssign for ProgrammerStateSet

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<&ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: &ProgrammerState) -> Self

Performs the | operation.

impl BitOr<&ProgrammerStateSet> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: &Self) -> Self

Performs the | operation.

impl BitOr<ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: ProgrammerState) -> Self

Performs the | operation.

impl BitOr for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign<&ProgrammerStateSet> for ProgrammerStateSet

fn bitor_assign(&mut self, rhs: &Self)

Performs the |= operation.

impl BitOrAssign for ProgrammerStateSet

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<&ProgrammerStateSet> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &Self) -> Self

Performs the ^ operation.

impl BitXor for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<&ProgrammerStateSet> for ProgrammerStateSet

fn bitxor_assign(&mut self, rhs: &Self)

Performs the ^= operation.

impl BitXorAssign for ProgrammerStateSet

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for ProgrammerStateSet

fn clone(&self) -> ProgrammerStateSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgrammerStateSet

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

Formats the value using the given formatter.

impl Default for ProgrammerStateSet

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Extend<&'a ProgrammerState> for ProgrammerStateSet

fn extend<T: IntoIterator<Item = &'a ProgrammerState>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

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 Extend<ProgrammerState> for ProgrammerStateSet

fn extend<T: IntoIterator<Item = ProgrammerState>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

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 From<&ProgrammerState> for ProgrammerStateSet

fn from(item: &ProgrammerState) -> Self

Converts to this type from the input type.

impl From<ProgrammerState> for ProgrammerStateSet

fn from(item: ProgrammerState) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a ProgrammerState> for ProgrammerStateSet

fn from_iter<T: IntoIterator<Item = &'a ProgrammerState>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<ProgrammerState> for ProgrammerStateSet

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

Creates a value from an iterator.

impl Hash for ProgrammerStateSet

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 ProgrammerStateSet

type Item = ProgrammerState

The type of the elements being iterated over.

type IntoIter = ProgrammerStateSetSetIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Not for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Ord for ProgrammerStateSet

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProgrammerStateSet

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ProgrammerStateSet

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<&ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the - operator.

fn sub(self, rhs: &ProgrammerState) -> Self

Performs the - operation.

impl Sub<&ProgrammerStateSet> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the - operator.

fn sub(self, rhs: &Self) -> Self

Performs the - operation.

impl Sub<ProgrammerState> for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the - operator.

fn sub(self, rhs: ProgrammerState) -> Self

Performs the - operation.

impl Sub for ProgrammerStateSet

type Output = ProgrammerStateSet

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&ProgrammerState> for ProgrammerStateSet

fn sub_assign(&mut self, rhs: &ProgrammerState)

Performs the -= operation.

impl SubAssign<&ProgrammerStateSet> for ProgrammerStateSet

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl SubAssign<ProgrammerState> for ProgrammerStateSet

fn sub_assign(&mut self, rhs: ProgrammerState)

Performs the -= operation.

impl SubAssign for ProgrammerStateSet

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for ProgrammerStateSet

impl Eq for ProgrammerStateSet

impl StructuralPartialEq for ProgrammerStateSet