Struct colorz::EffectFlags

pub struct EffectFlags { /* private fields */ }

A collection of Effects

Implementations

impl EffectFlags

pub const fn new() -> Self

Create an empty set of effects

pub const fn all() -> Self

Create a set of all effects

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

Create a set of effects from an array

pub const fn is_plain(self) -> bool

Are there no effects

pub const fn is(self, opt: Effect) -> bool

Is this effect in the collection

pub const fn is_any(self, opt: EffectFlags) -> bool

Do these two collections intersect

pub const fn with(self, opt: Effect) -> Self

Add an effect to the set

pub const fn without(self, opt: Effect) -> Self

Remove an effect from the set

pub const fn toggled(self, opt: Effect) -> Self

Toggle an effect in the set

pub fn set(&mut self, opt: Effect)

Add an effect to the set in place

pub fn unset(&mut self, opt: Effect)

Remove an effect from the set in place

pub fn toggle(&mut self, opt: Effect)

Toggle an effect in the set in place

pub const fn iter(self) -> EffectFlagsIter

Iterate over all effects

Trait Implementations

impl Clone for EffectFlags

fn clone(&self) -> EffectFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectFlags

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

Formats the value using the given formatter.

impl<E: Into<Effect>> FromIterator<E> for EffectFlags

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

Creates a value from an iterator.

impl Hash for EffectFlags

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 EffectFlags

type Item = Effect

The type of the elements being iterated over.

type IntoIter = EffectFlagsIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<EffectFlags> for EffectFlags

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

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

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

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

impl Copy for EffectFlags

impl Eq for EffectFlags

impl StructuralEq for EffectFlags

impl StructuralPartialEq for EffectFlags