Struct rustc::hir::def_id::DefIndex

pub struct DefIndex(u32);

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

A DefIndex is an index into the hir-map for a crate, identifying a particular definition. It should really be considered an interned shorthand for a particular DefPath.

At the moment we are allocating the numerical values of DefIndexes from two address spaces: DefIndexAddressSpace::Low and DefIndexAddressSpace::High. This allows us to allocate the DefIndexes of all item-likes (Items, TraitItems, and ImplItems) into one of these spaces and consequently use a simple array for lookup tables keyed by DefIndex and known to be densely populated. This is especially important for the HIR map.

Since the DefIndex is mostly treated as an opaque ID, you probably don't have to care about these address spaces.

Methods

impl DefIndex

pub fn address_space(&self) -> DefIndexAddressSpace

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn as_array_index(&self) -> usize

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Converts this DefIndex into a zero-based array index. This index is the offset within the given DefIndexAddressSpace.

pub fn from_array_index(     i: usize,     address_space: DefIndexAddressSpace ) -> DefIndex

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn from_proc_macro_index(proc_macro_index: usize) -> DefIndex

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn to_proc_macro_index(self: DefIndex) -> usize

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn from_raw_u32(x: u32) -> DefIndex

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn as_raw_u32(&self) -> u32

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Trait Implementations

impl<'a, 'gcx: 'tcx + 'a, 'tcx: 'a> DepNodeParams<'a, 'gcx, 'tcx> for DefIndex

const CAN_RECONSTRUCT_QUERY_KEY: bool

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

fn to_fingerprint(&self, tcx: TyCtxt) -> Fingerprint

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don't need to if the corresponding DepNode is anonymous).

fn to_debug_str(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> String

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl Clone for DefIndex

fn clone(&self) -> DefIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for DefIndex

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

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

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

This method tests for !=.

impl Eq for DefIndex

fn assert_receiver_is_total_eq(&self)

impl PartialOrd for DefIndex

fn partial_cmp(&self, other: &DefIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DefIndex) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DefIndex) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DefIndex) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DefIndex) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for DefIndex

fn cmp(&self, other: &DefIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for DefIndex

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,

Feeds a slice of this type into the given [Hasher].

impl Copy for DefIndex

impl Debug for DefIndex

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

Formats the value using the given formatter.

impl UseSpecializedEncodable for DefIndex

fn default_encode<E>(&self, &mut E) -> Result<(), <E as Encoder>::Error> where     E: Encoder,

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Defaults to returning an error (see SpecializationError).

impl UseSpecializedDecodable for DefIndex

fn default_decode<D>(&mut D) -> Result<Self, <D as Decoder>::Error> where     D: Decoder,

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Defaults to returning an error (see SpecializationError).

impl<'a> HashStable<StableHashingContext<'a>> for DefIndex

fn hash_stable<W: StableHasherResult>(     &self,     hcx: &mut StableHashingContext<'a>,     hasher: &mut StableHasher<W> )

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'a> ToStableHashKey<StableHashingContext<'a>> for DefIndex

type KeyType = DefPathHash

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

fn to_stable_hash_key(&self, hcx: &StableHashingContext<'a>) -> DefPathHash

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl Key for DefIndex

fn query_crate(&self) -> CrateNum

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Given an instance of this key, what crate is it referring to? This is used to find the provider.

fn default_span(&self, _tcx: TyCtxt) -> Span

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

In the event that a cycle occurs, if no explicit span has been given for a query with key self, what span should we use?

impl<'a, 'tcx, 'x> SpecializedDecoder<DefIndex> for CacheDecoder<'a, 'tcx, 'x>

fn specialized_decode(&mut self) -> Result<DefIndex, Self::Error>

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Decode a value in a manner specific to this decoder state.

impl<'enc, 'a, 'tcx, E> SpecializedEncoder<DefIndex> for CacheEncoder<'enc, 'a, 'tcx, E> where     E: 'enc + TyEncoder,

fn specialized_encode(&mut self, _: &DefIndex) -> Result<(), Self::Error>

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Encode the value in a manner specific to this encoder state.