Struct BitFlags

pub struct BitFlags<F, U>
where
    U: BitFlagsIntegerUnsigned + From<F>,
    F: MaxValue + Copy,
{ /* private fields */ }

Implementations

impl<F, U> BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

pub const unsafe fn from_flags_unchecked(flags: U) -> Self

pub fn try_from_flags(flags: U) -> Option<Self>

Return None if the flags contains unknow toggled bit (greater than F::MAX)

pub fn from_flags(flags: U) -> Self

pub fn from_flag(flag: F) -> Self

pub fn new() -> Self

pub fn flags(self) -> U

impl<F, U> BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

pub fn with(self, flag: F, set: bool) -> Self

Set the flag using a bool

pub fn added(self, flag: F) -> Self

Set the flag to 1, even if the flag was already 1

pub fn removed(self, flag: F) -> Self

Set the flag to 0, even if the flag was already 0

pub fn toggled(self, flag: F) -> Self

Flip the flag transforming 1 <=> 0

pub fn set(&mut self, flag: F, set: bool) -> &mut Self

Set the flag using a bool

pub fn add(&mut self, flag: F) -> &mut Self

Set the flag to 1, even if the flag was already 1

pub fn remove(&mut self, flag: F) -> &mut Self

Set the flag to 0, even if the flag was already 0

pub fn toggle(&mut self, flag: F) -> &mut Self

Flip the flag transforming 1 <=> 0

pub fn have(&self, flag: F) -> bool

Check if a flag is present

pub fn have_any(&self, flags: &[F]) -> bool

pub fn have_all(&self, flags: &[F]) -> bool

Trait Implementations

impl<F, U> BitAnd<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<F, U> BitAnd for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<F, U> BitAndAssign<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitand_assign(&mut self, rhs: F)

Performs the &= operation.

impl<F, U> BitAndAssign for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<F, U> BitOr<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<F, U> BitOr for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<F, U> BitOrAssign<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitor_assign(&mut self, rhs: F)

Performs the |= operation.

impl<F, U> BitOrAssign for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<F, U> BitXor<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<F, U> BitXor for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<F, U> BitXorAssign<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitxor_assign(&mut self, rhs: F)

Performs the ^= operation.

impl<F, U> BitXorAssign for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<F, U> Clone for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Clone, F: MaxValue + Copy + Clone,

fn clone(&self) -> BitFlags<F, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F, U> Debug for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy + TryFrom<U> + Debug, RangeInclusive<U>: Iterator<Item = U>,

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

Formats the value using the given formatter.

impl<'de, F, U> Deserialize<'de> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Deserialize<'de>, F: MaxValue + Copy,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F, U> From<F> for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

fn from(value: F) -> Self

Converts to this type from the input type.

impl<F, U> Hash for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Hash, F: MaxValue + Copy + Hash,

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<F, U> IntoIterator for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy + TryFrom<U>, RangeInclusive<U>: Iterator<Item = U>,

type Item = F

The type of the elements being iterated over.

type IntoIter = BitFlagsIntoIter<F, U>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<F, U> Not for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

type Output = BitFlags<F, U>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<F, U> Ord for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Ord, F: MaxValue + Copy + Ord,

fn cmp(&self, other: &BitFlags<F, U>) -> 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<F, U> PartialEq for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + PartialEq, F: MaxValue + Copy + PartialEq,

fn eq(&self, other: &BitFlags<F, U>) -> 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<F, U> PartialOrd for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + PartialOrd, F: MaxValue + Copy + PartialOrd,

fn partial_cmp(&self, other: &BitFlags<F, U>) -> 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<F, U> Serialize for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Serialize, F: MaxValue + Copy,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<F, U> Zero for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,

const ZERO: Self

The absorbing element of the multiplication such that x * X::ZERO = X::ZERO

fn zero() -> Self

fn set_zero(&mut self) -> &mut Self

fn is_zero(&self) -> bool

where Self: PartialEq,

fn is_non_zero(&self) -> bool

where Self: PartialEq,

impl<F, U> Copy for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Copy, F: MaxValue + Copy + Copy,

impl<F, U> Eq for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F> + Eq, F: MaxValue + Copy + Eq,

impl<F, U> StructuralPartialEq for BitFlags<F, U>

where U: BitFlagsIntegerUnsigned + From<F>, F: MaxValue + Copy,