pub struct Ruleset(/* private fields */);
Implementations§
source§impl Ruleset
impl Ruleset
sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u64) -> Option<Ruleset>
pub const fn from_bits(bits: u64) -> Option<Ruleset>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u64) -> Ruleset
pub const fn from_bits_truncate(bits: u64) -> Ruleset
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u64) -> Ruleset
pub const fn from_bits_retain(bits: u64) -> Ruleset
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Ruleset>
pub fn from_name(name: &str) -> Option<Ruleset>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Ruleset) -> bool
pub const fn intersects(&self, other: Ruleset) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Ruleset) -> bool
pub const fn contains(&self, other: Ruleset) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Ruleset)
pub fn remove(&mut self, other: Ruleset)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Ruleset)
pub fn toggle(&mut self, other: Ruleset)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Ruleset, value: bool)
pub fn set(&mut self, other: Ruleset, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Ruleset) -> Ruleset
pub const fn intersection(self, other: Ruleset) -> Ruleset
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Ruleset) -> Ruleset
pub const fn union(self, other: Ruleset) -> Ruleset
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Ruleset) -> Ruleset
pub const fn difference(self, other: Ruleset) -> Ruleset
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Ruleset) -> Ruleset
pub const fn symmetric_difference(self, other: Ruleset) -> Ruleset
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Ruleset
pub const fn complement(self) -> Ruleset
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl Ruleset
impl Ruleset
sourcepub const fn iter(&self) -> Iter<Ruleset>
pub const fn iter(&self) -> Iter<Ruleset>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<Ruleset>
pub const fn iter_names(&self) -> IterNames<Ruleset>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl BitAndAssign for Ruleset
impl BitAndAssign for Ruleset
source§fn bitand_assign(&mut self, other: Ruleset)
fn bitand_assign(&mut self, other: Ruleset)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign for Ruleset
impl BitOrAssign for Ruleset
source§fn bitor_assign(&mut self, other: Ruleset)
fn bitor_assign(&mut self, other: Ruleset)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign for Ruleset
impl BitXorAssign for Ruleset
source§fn bitxor_assign(&mut self, other: Ruleset)
fn bitxor_assign(&mut self, other: Ruleset)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl<'de> Deserialize<'de> for Ruleset
impl<'de> Deserialize<'de> for Ruleset
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<Ruleset, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<Ruleset, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl Extend<Ruleset> for Ruleset
impl Extend<Ruleset> for Ruleset
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Ruleset>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Ruleset>,
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for Ruleset
impl Flags for Ruleset
source§fn from_bits_retain(bits: u64) -> Ruleset
fn from_bits_retain(bits: u64) -> Ruleset
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<Ruleset> for Ruleset
impl FromIterator<Ruleset> for Ruleset
source§impl IntoIterator for Ruleset
impl IntoIterator for Ruleset
source§impl Ord for Ruleset
impl Ord for Ruleset
source§impl PartialEq for Ruleset
impl PartialEq for Ruleset
source§impl PartialOrd for Ruleset
impl PartialOrd for Ruleset
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for Ruleset
impl Serialize for Ruleset
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
source§impl Sub for Ruleset
impl Sub for Ruleset
source§impl SubAssign for Ruleset
impl SubAssign for Ruleset
source§fn sub_assign(&mut self, other: Ruleset)
fn sub_assign(&mut self, other: Ruleset)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.