Struct Flags

pub struct Flags<Enum, Primitive = <Enum as Flag>::Primitive> { /* private fields */ }

Storage type for handling flags

Implementations

impl<Enum> Flags<Enum>

where Enum: Flag,

pub fn from_flag(flag: Enum) -> Self

Get a flag from a single enum value

pub fn from_bits(bits: <Enum as Flag>::Primitive) -> Self

Get a flag from a numeric value

Note: the value is unchecked so any bit may be set. Be careful because PartialEq is a direct comparison of underlying bits.

pub fn bits(&self) -> <Enum as Flag>::Primitive

Numeric representation of the variant

pub fn bits_ref(&self) -> &<Enum as Flag>::Primitive

Reference to numeric representation of the variant

pub fn intersects<B: Into<Flags<Enum>>>(self, rhs: B) -> bool

Check if at least one flag in common is set

pub fn contains<B: Into<Flags<Enum>>>(self, rhs: B) -> bool

Check if all flags provided in rhs are set

pub fn is_empty(&self) -> bool

pub fn is_all(&self) -> bool

Trait Implementations

impl<T: Flag> Binary for Flags<T>

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

Formats the value using the given formatter.

impl<T, B> BitAnd<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

type Output = Flags<T>

The resulting type after applying the & operator.

fn bitand(self, other: B) -> Flags<T>

Performs the & operation.

impl<T, B> BitAndAssign<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

fn bitand_assign(&mut self, rhs: B)

Performs the &= operation.

impl<T, B> BitOr<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

type Output = Flags<T>

The resulting type after applying the | operator.

fn bitor(self, other: B) -> Flags<T>

Performs the | operation.

impl<T, B> BitOrAssign<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

fn bitor_assign(&mut self, rhs: B)

Performs the |= operation.

impl<T, B> BitXor<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

type Output = Flags<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: B) -> Flags<T>

Performs the ^ operation.

impl<T, B> BitXorAssign<B> for Flags<T>

where T: Flag, B: Into<Flags<T>>,

fn bitxor_assign(&mut self, rhs: B)

Performs the ^= operation.

impl<Enum: Clone, Primitive: Clone> Clone for Flags<Enum, Primitive>

fn clone(&self) -> Flags<Enum, Primitive>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Enum> Debug for Flags<Enum>

where Enum: Flag,

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

Formats the value using the given formatter.

impl<Enum> Default for Flags<Enum>

where Enum: Flag,

fn default() -> Self

Returns the “default value” for a type.

impl<T: Flag> Display for Flags<T>

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

A pipe-separated list of set flags.

impl<Enum: Flag> From<Enum> for Flags<Enum>

fn from(flag: Enum) -> Self

Converts to this type from the input type.

impl<T: Flag> Not for Flags<T>

type Output = Flags<T>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<Enum: Flag> PartialEq<Enum> for Flags<Enum>

fn eq(&self, other: &Enum) -> 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 PartialEq<Flags<Test>> for Test

fn eq(&self, other: &Flags<Self>) -> 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<Enum: PartialEq, Primitive: PartialEq> PartialEq for Flags<Enum, Primitive>

fn eq(&self, other: &Flags<Enum, Primitive>) -> 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<Enum: Copy, Primitive: Copy> Copy for Flags<Enum, Primitive>

impl<Enum: Eq, Primitive: Eq> Eq for Flags<Enum, Primitive>

impl<Enum, Primitive> StructuralPartialEq for Flags<Enum, Primitive>