Struct modalkit::prelude::TargetShapeFilter
source · pub struct TargetShapeFilter(/* private fields */);
Expand description
Bitmask that specifies what shapes are targeted by an action.
Implementations§
source§impl TargetShapeFilter
impl TargetShapeFilter
sourcepub const CHAR: Self = _
pub const CHAR: Self = _
Match TargetShape::CharWise.
sourcepub const LINE: Self = _
pub const LINE: Self = _
Match TargetShape::LineWise.
sourcepub const BLOCK: Self = _
pub const BLOCK: Self = _
Match TargetShape::BlockWise.
source§impl TargetShapeFilter
impl TargetShapeFilter
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl TargetShapeFilter
impl TargetShapeFilter
sourcepub const fn iter(&self) -> Iter<TargetShapeFilter>
pub const fn iter(&self) -> Iter<TargetShapeFilter>
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<TargetShapeFilter>
pub const fn iter_names(&self) -> IterNames<TargetShapeFilter>
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.
source§impl TargetShapeFilter
impl TargetShapeFilter
sourcepub fn matches(&self, shape: &TargetShape) -> bool
pub fn matches(&self, shape: &TargetShape) -> bool
Check whether this filter applies to a given TargetShape.
Trait Implementations§
source§impl Binary for TargetShapeFilter
impl Binary for TargetShapeFilter
source§impl BitAnd for TargetShapeFilter
impl BitAnd for TargetShapeFilter
source§impl BitAndAssign for TargetShapeFilter
impl BitAndAssign for TargetShapeFilter
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for TargetShapeFilter
impl BitOr for TargetShapeFilter
source§fn bitor(self, other: TargetShapeFilter) -> Self
fn bitor(self, other: TargetShapeFilter) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = TargetShapeFilter
type Output = TargetShapeFilter
|
operator.source§impl BitOrAssign for TargetShapeFilter
impl BitOrAssign for TargetShapeFilter
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for TargetShapeFilter
impl BitXor for TargetShapeFilter
source§impl BitXorAssign for TargetShapeFilter
impl BitXorAssign for TargetShapeFilter
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for TargetShapeFilter
impl Clone for TargetShapeFilter
source§fn clone(&self) -> TargetShapeFilter
fn clone(&self) -> TargetShapeFilter
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TargetShapeFilter
impl Debug for TargetShapeFilter
source§impl Extend<TargetShapeFilter> for TargetShapeFilter
impl Extend<TargetShapeFilter> for TargetShapeFilter
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 TargetShapeFilter
impl Flags for TargetShapeFilter
source§const FLAGS: &'static [Flag<TargetShapeFilter>] = _
const FLAGS: &'static [Flag<TargetShapeFilter>] = _
source§fn from_bits_retain(bits: u32) -> TargetShapeFilter
fn from_bits_retain(bits: u32) -> TargetShapeFilter
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<TargetShapeFilter> for TargetShapeFilter
impl FromIterator<TargetShapeFilter> for TargetShapeFilter
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for TargetShapeFilter
impl IntoIterator for TargetShapeFilter
source§impl LowerHex for TargetShapeFilter
impl LowerHex for TargetShapeFilter
source§impl Not for TargetShapeFilter
impl Not for TargetShapeFilter
source§impl Octal for TargetShapeFilter
impl Octal for TargetShapeFilter
source§impl PartialEq for TargetShapeFilter
impl PartialEq for TargetShapeFilter
source§fn eq(&self, other: &TargetShapeFilter) -> bool
fn eq(&self, other: &TargetShapeFilter) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for TargetShapeFilter
impl PublicFlags for TargetShapeFilter
source§impl Sub for TargetShapeFilter
impl Sub for TargetShapeFilter
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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.
§type Output = TargetShapeFilter
type Output = TargetShapeFilter
-
operator.source§impl SubAssign for TargetShapeFilter
impl SubAssign for TargetShapeFilter
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.
source§impl UpperHex for TargetShapeFilter
impl UpperHex for TargetShapeFilter
impl Copy for TargetShapeFilter
impl Eq for TargetShapeFilter
impl StructuralPartialEq for TargetShapeFilter
Auto Trait Implementations§
impl Freeze for TargetShapeFilter
impl RefUnwindSafe for TargetShapeFilter
impl Send for TargetShapeFilter
impl Sync for TargetShapeFilter
impl Unpin for TargetShapeFilter
impl UnwindSafe for TargetShapeFilter
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.