Struct lldb::SymbolContextItem
source · [−]#[repr(C)]pub struct SymbolContextItem { /* private fields */ }
Expand description
These mask bits allow a common interface for queries that can limit the amount of information that gets parsed to only the information that is requested. These bits also can indicate what actually did get resolved during query function calls.
Each definition corresponds to a one of the member variables in this class, and requests that that item be resolved, or indicates that the member did get resolved.
Implementations
sourceimpl SymbolContextItem
impl SymbolContextItem
sourcepub const TARGET: SymbolContextItem = Self{ bits: 1,}
pub const TARGET: SymbolContextItem = Self{ bits: 1,}
Set when a target is requested from a query or was located in the query results.
sourcepub const MODULE: SymbolContextItem = Self{ bits: 2,}
pub const MODULE: SymbolContextItem = Self{ bits: 2,}
Set when a module is requested from a query or was located in the query results.
sourcepub const COMPUNIT: SymbolContextItem = Self{ bits: 4,}
pub const COMPUNIT: SymbolContextItem = Self{ bits: 4,}
Set when a compilation unit is requested from a query or was located in the query results.
sourcepub const FUNCTION: SymbolContextItem = Self{ bits: 8,}
pub const FUNCTION: SymbolContextItem = Self{ bits: 8,}
Set when a function is requested from a query or was located in the query results.
sourcepub const BLOCK: SymbolContextItem = Self{ bits: 16,}
pub const BLOCK: SymbolContextItem = Self{ bits: 16,}
Set when the deepest block is requested from a query or was located in the query results.
sourcepub const LINE_ENTRY: SymbolContextItem = Self{ bits: 32,}
pub const LINE_ENTRY: SymbolContextItem = Self{ bits: 32,}
Set when a line entry is requested from a query or was located in the query results.
sourcepub const SYMBOL: SymbolContextItem = Self{ bits: 64,}
pub const SYMBOL: SymbolContextItem = Self{ bits: 64,}
Set when a symbol is requested from a query or was located in the query results.
sourcepub const EVERYTHING: SymbolContextItem = Self{
bits:
Self::TARGET.bits | Self::MODULE.bits | Self::COMPUNIT.bits |
Self::FUNCTION.bits | Self::BLOCK.bits |
Self::LINE_ENTRY.bits | Self::SYMBOL.bits,}
pub const EVERYTHING: SymbolContextItem = Self{ bits: Self::TARGET.bits | Self::MODULE.bits | Self::COMPUNIT.bits | Self::FUNCTION.bits | Self::BLOCK.bits | Self::LINE_ENTRY.bits | Self::SYMBOL.bits,}
Indicates to try and look everything up during a routine symbol context query. This doesn’t actually include looking up a variable.
sourcepub const VARIABLE: SymbolContextItem = Self{ bits: 128,}
pub const VARIABLE: SymbolContextItem = Self{ bits: 128,}
Set when a global or static variable is requested from a query, or was located in the query results.
This is potentially expensive to look up, so it isn’t included in
EVERYTHING
which stops it from being used during frame PC
lookups and many other potential address to symbol context lookups.
sourcepub const fn empty() -> SymbolContextItem
pub const fn empty() -> SymbolContextItem
Returns an empty set of flags.
sourcepub const fn all() -> SymbolContextItem
pub const fn all() -> SymbolContextItem
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<SymbolContextItem>
pub const fn from_bits(bits: u32) -> Option<SymbolContextItem>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> SymbolContextItem
pub const fn from_bits_truncate(bits: u32) -> SymbolContextItem
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> SymbolContextItem
pub const unsafe fn from_bits_unchecked(bits: u32) -> SymbolContextItem
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: SymbolContextItem) -> bool
pub const fn intersects(&self, other: SymbolContextItem) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: SymbolContextItem) -> bool
pub const fn contains(&self, other: SymbolContextItem) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: SymbolContextItem)
pub fn insert(&mut self, other: SymbolContextItem)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: SymbolContextItem)
pub fn remove(&mut self, other: SymbolContextItem)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: SymbolContextItem)
pub fn toggle(&mut self, other: SymbolContextItem)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: SymbolContextItem, value: bool)
pub fn set(&mut self, other: SymbolContextItem, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: SymbolContextItem) -> SymbolContextItem
pub const fn intersection(self, other: SymbolContextItem) -> SymbolContextItem
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: SymbolContextItem) -> SymbolContextItem
pub const fn union(self, other: SymbolContextItem) -> SymbolContextItem
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: SymbolContextItem) -> SymbolContextItem
pub const fn difference(self, other: SymbolContextItem) -> SymbolContextItem
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(
self,
other: SymbolContextItem
) -> SymbolContextItem
pub const fn symmetric_difference(
self,
other: SymbolContextItem
) -> SymbolContextItem
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> SymbolContextItem
pub const fn complement(self) -> SymbolContextItem
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for SymbolContextItem
impl Binary for SymbolContextItem
sourceimpl BitAnd<SymbolContextItem> for SymbolContextItem
impl BitAnd<SymbolContextItem> for SymbolContextItem
sourcefn bitand(self, other: SymbolContextItem) -> SymbolContextItem
fn bitand(self, other: SymbolContextItem) -> SymbolContextItem
Returns the intersection between the two sets of flags.
type Output = SymbolContextItem
type Output = SymbolContextItem
&
operator.sourceimpl BitAndAssign<SymbolContextItem> for SymbolContextItem
impl BitAndAssign<SymbolContextItem> for SymbolContextItem
sourcefn bitand_assign(&mut self, other: SymbolContextItem)
fn bitand_assign(&mut self, other: SymbolContextItem)
Disables all flags disabled in the set.
sourceimpl BitOr<SymbolContextItem> for SymbolContextItem
impl BitOr<SymbolContextItem> for SymbolContextItem
sourcefn bitor(self, other: SymbolContextItem) -> SymbolContextItem
fn bitor(self, other: SymbolContextItem) -> SymbolContextItem
Returns the union of the two sets of flags.
type Output = SymbolContextItem
type Output = SymbolContextItem
|
operator.sourceimpl BitOrAssign<SymbolContextItem> for SymbolContextItem
impl BitOrAssign<SymbolContextItem> for SymbolContextItem
sourcefn bitor_assign(&mut self, other: SymbolContextItem)
fn bitor_assign(&mut self, other: SymbolContextItem)
Adds the set of flags.
sourceimpl BitXor<SymbolContextItem> for SymbolContextItem
impl BitXor<SymbolContextItem> for SymbolContextItem
sourcefn bitxor(self, other: SymbolContextItem) -> SymbolContextItem
fn bitxor(self, other: SymbolContextItem) -> SymbolContextItem
Returns the left flags, but with all the right flags toggled.
type Output = SymbolContextItem
type Output = SymbolContextItem
^
operator.sourceimpl BitXorAssign<SymbolContextItem> for SymbolContextItem
impl BitXorAssign<SymbolContextItem> for SymbolContextItem
sourcefn bitxor_assign(&mut self, other: SymbolContextItem)
fn bitxor_assign(&mut self, other: SymbolContextItem)
Toggles the set of flags.
sourceimpl Clone for SymbolContextItem
impl Clone for SymbolContextItem
sourcefn clone(&self) -> SymbolContextItem
fn clone(&self) -> SymbolContextItem
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for SymbolContextItem
impl Debug for SymbolContextItem
sourceimpl Extend<SymbolContextItem> for SymbolContextItem
impl Extend<SymbolContextItem> for SymbolContextItem
sourcefn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = SymbolContextItem>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = SymbolContextItem>,
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<SymbolContextItem> for SymbolContextItem
impl FromIterator<SymbolContextItem> for SymbolContextItem
sourcefn from_iter<T>(iterator: T) -> SymbolContextItemwhere
T: IntoIterator<Item = SymbolContextItem>,
fn from_iter<T>(iterator: T) -> SymbolContextItemwhere
T: IntoIterator<Item = SymbolContextItem>,
sourceimpl Hash for SymbolContextItem
impl Hash for SymbolContextItem
sourceimpl LowerHex for SymbolContextItem
impl LowerHex for SymbolContextItem
sourceimpl Not for SymbolContextItem
impl Not for SymbolContextItem
sourcefn not(self) -> SymbolContextItem
fn not(self) -> SymbolContextItem
Returns the complement of this set of flags.
type Output = SymbolContextItem
type Output = SymbolContextItem
!
operator.sourceimpl Octal for SymbolContextItem
impl Octal for SymbolContextItem
sourceimpl Ord for SymbolContextItem
impl Ord for SymbolContextItem
sourcefn cmp(&self, other: &SymbolContextItem) -> Ordering
fn cmp(&self, other: &SymbolContextItem) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<SymbolContextItem> for SymbolContextItem
impl PartialEq<SymbolContextItem> for SymbolContextItem
sourcefn eq(&self, other: &SymbolContextItem) -> bool
fn eq(&self, other: &SymbolContextItem) -> bool
sourceimpl PartialOrd<SymbolContextItem> for SymbolContextItem
impl PartialOrd<SymbolContextItem> for SymbolContextItem
sourcefn partial_cmp(&self, other: &SymbolContextItem) -> Option<Ordering>
fn partial_cmp(&self, other: &SymbolContextItem) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<SymbolContextItem> for SymbolContextItem
impl Sub<SymbolContextItem> for SymbolContextItem
sourcefn sub(self, other: SymbolContextItem) -> SymbolContextItem
fn sub(self, other: SymbolContextItem) -> SymbolContextItem
Returns the set difference of the two sets of flags.
type Output = SymbolContextItem
type Output = SymbolContextItem
-
operator.sourceimpl SubAssign<SymbolContextItem> for SymbolContextItem
impl SubAssign<SymbolContextItem> for SymbolContextItem
sourcefn sub_assign(&mut self, other: SymbolContextItem)
fn sub_assign(&mut self, other: SymbolContextItem)
Disables all flags enabled in the set.