Struct ide::ReferenceCategory
source · pub struct ReferenceCategory(/* private fields */);
Implementations§
source§impl ReferenceCategory
impl ReferenceCategory
pub const WRITE: ReferenceCategory = _
pub const READ: ReferenceCategory = _
pub const IMPORT: ReferenceCategory = _
pub const TEST: ReferenceCategory = _
source§impl ReferenceCategory
impl ReferenceCategory
sourcepub const fn empty() -> ReferenceCategory
pub const fn empty() -> ReferenceCategory
Get a flags value with all bits unset.
sourcepub const fn all() -> ReferenceCategory
pub const fn all() -> ReferenceCategory
Get a flags value with all known bits set.
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<ReferenceCategory>
pub const fn from_bits(bits: u8) -> Option<ReferenceCategory>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> ReferenceCategory
pub const fn from_bits_truncate(bits: u8) -> ReferenceCategory
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> ReferenceCategory
pub const fn from_bits_retain(bits: u8) -> ReferenceCategory
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<ReferenceCategory>
pub fn from_name(name: &str) -> Option<ReferenceCategory>
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: ReferenceCategory) -> bool
pub const fn intersects(&self, other: ReferenceCategory) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: ReferenceCategory) -> bool
pub const fn contains(&self, other: ReferenceCategory) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn insert(&mut self, other: ReferenceCategory)
pub fn insert(&mut self, other: ReferenceCategory)
The bitwise or (|
) of the bits in two flags values.
sourcepub fn remove(&mut self, other: ReferenceCategory)
pub fn remove(&mut self, other: ReferenceCategory)
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: ReferenceCategory)
pub fn toggle(&mut self, other: ReferenceCategory)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: ReferenceCategory, value: bool)
pub fn set(&mut self, other: ReferenceCategory, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: ReferenceCategory) -> ReferenceCategory
pub const fn intersection(self, other: ReferenceCategory) -> ReferenceCategory
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: ReferenceCategory) -> ReferenceCategory
pub const fn union(self, other: ReferenceCategory) -> ReferenceCategory
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: ReferenceCategory) -> ReferenceCategory
pub const fn difference(self, other: ReferenceCategory) -> ReferenceCategory
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: ReferenceCategory,
) -> ReferenceCategory
pub const fn symmetric_difference( self, other: ReferenceCategory, ) -> ReferenceCategory
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> ReferenceCategory
pub const fn complement(self) -> ReferenceCategory
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ReferenceCategory
impl ReferenceCategory
sourcepub const fn iter(&self) -> Iter<ReferenceCategory>
pub const fn iter(&self) -> Iter<ReferenceCategory>
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<ReferenceCategory>
pub const fn iter_names(&self) -> IterNames<ReferenceCategory>
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 Binary for ReferenceCategory
impl Binary for ReferenceCategory
source§impl BitAnd for ReferenceCategory
impl BitAnd for ReferenceCategory
source§fn bitand(self, other: ReferenceCategory) -> ReferenceCategory
fn bitand(self, other: ReferenceCategory) -> ReferenceCategory
The bitwise and (&
) of the bits in two flags values.
source§type Output = ReferenceCategory
type Output = ReferenceCategory
&
operator.source§impl BitAndAssign for ReferenceCategory
impl BitAndAssign for ReferenceCategory
source§fn bitand_assign(&mut self, other: ReferenceCategory)
fn bitand_assign(&mut self, other: ReferenceCategory)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ReferenceCategory
impl BitOr for ReferenceCategory
source§fn bitor(self, other: ReferenceCategory) -> ReferenceCategory
fn bitor(self, other: ReferenceCategory) -> ReferenceCategory
The bitwise or (|
) of the bits in two flags values.
source§type Output = ReferenceCategory
type Output = ReferenceCategory
|
operator.source§impl BitOrAssign for ReferenceCategory
impl BitOrAssign for ReferenceCategory
source§fn bitor_assign(&mut self, other: ReferenceCategory)
fn bitor_assign(&mut self, other: ReferenceCategory)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ReferenceCategory
impl BitXor for ReferenceCategory
source§fn bitxor(self, other: ReferenceCategory) -> ReferenceCategory
fn bitxor(self, other: ReferenceCategory) -> ReferenceCategory
The bitwise exclusive-or (^
) of the bits in two flags values.
source§type Output = ReferenceCategory
type Output = ReferenceCategory
^
operator.source§impl BitXorAssign for ReferenceCategory
impl BitXorAssign for ReferenceCategory
source§fn bitxor_assign(&mut self, other: ReferenceCategory)
fn bitxor_assign(&mut self, other: ReferenceCategory)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ReferenceCategory
impl Clone for ReferenceCategory
source§fn clone(&self) -> ReferenceCategory
fn clone(&self) -> ReferenceCategory
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ReferenceCategory
impl Debug for ReferenceCategory
source§impl Default for ReferenceCategory
impl Default for ReferenceCategory
source§fn default() -> ReferenceCategory
fn default() -> ReferenceCategory
source§impl Extend<ReferenceCategory> for ReferenceCategory
impl Extend<ReferenceCategory> for ReferenceCategory
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ReferenceCategory>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ReferenceCategory>,
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 ReferenceCategory
impl Flags for ReferenceCategory
source§const FLAGS: &'static [Flag<ReferenceCategory>] = _
const FLAGS: &'static [Flag<ReferenceCategory>] = _
source§fn from_bits_retain(bits: u8) -> ReferenceCategory
fn from_bits_retain(bits: u8) -> ReferenceCategory
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§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.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§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.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<ReferenceCategory> for ReferenceCategory
impl FromIterator<ReferenceCategory> for ReferenceCategory
source§fn from_iter<T>(iterator: T) -> ReferenceCategorywhere
T: IntoIterator<Item = ReferenceCategory>,
fn from_iter<T>(iterator: T) -> ReferenceCategorywhere
T: IntoIterator<Item = ReferenceCategory>,
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ReferenceCategory
impl Hash for ReferenceCategory
source§impl IntoIterator for ReferenceCategory
impl IntoIterator for ReferenceCategory
source§type Item = ReferenceCategory
type Item = ReferenceCategory
source§type IntoIter = Iter<ReferenceCategory>
type IntoIter = Iter<ReferenceCategory>
source§fn into_iter(self) -> <ReferenceCategory as IntoIterator>::IntoIter
fn into_iter(self) -> <ReferenceCategory as IntoIterator>::IntoIter
source§impl LowerHex for ReferenceCategory
impl LowerHex for ReferenceCategory
source§impl Not for ReferenceCategory
impl Not for ReferenceCategory
source§fn not(self) -> ReferenceCategory
fn not(self) -> ReferenceCategory
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§type Output = ReferenceCategory
type Output = ReferenceCategory
!
operator.source§impl Octal for ReferenceCategory
impl Octal for ReferenceCategory
source§impl PartialEq for ReferenceCategory
impl PartialEq for ReferenceCategory
source§impl Sub for ReferenceCategory
impl Sub for ReferenceCategory
source§fn sub(self, other: ReferenceCategory) -> ReferenceCategory
fn sub(self, other: ReferenceCategory) -> ReferenceCategory
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§type Output = ReferenceCategory
type Output = ReferenceCategory
-
operator.source§impl SubAssign for ReferenceCategory
impl SubAssign for ReferenceCategory
source§fn sub_assign(&mut self, other: ReferenceCategory)
fn sub_assign(&mut self, other: ReferenceCategory)
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 ReferenceCategory
impl UpperHex for ReferenceCategory
impl Copy for ReferenceCategory
impl Eq for ReferenceCategory
impl StructuralPartialEq for ReferenceCategory
Auto Trait Implementations§
impl Freeze for ReferenceCategory
impl RefUnwindSafe for ReferenceCategory
impl Send for ReferenceCategory
impl Sync for ReferenceCategory
impl Unpin for ReferenceCategory
impl UnwindSafe for ReferenceCategory
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
§impl<T> Cast for T
impl<T> Cast for T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more