Struct Index 

pub struct Index {
    pub occurrences: Vec<Occurrence>,
    pub implements: Vec<(DefId, (DefId, u32))>,
    pub types: HashMap<Span, String>,
    pub locals: HashMap<Span, LocalFlags>,
    /* private fields */
}

Every name an analysis resolved (spec §3.1).

Fields

occurrences: Vec<Occurrence>

implements: Vec<(DefId, (DefId, u32))>

Each impl method that implements a trait’s method.

types: HashMap<Span, String>

Each local’s type as hover shows it, by declaration span.

locals: HashMap<Span, LocalFlags>

Each local’s declaration span: whether it is a parameter and whether it is mut (spec 3.4b §4.6, §7.2). Recorded with the index only.

Implementations

impl Index

pub fn record(&mut self, span: Span, role: Role, target: Target)

Record an occurrence, unless the same one is already recorded.

pub fn mark_shorthand(&mut self, span: Span)

Mark every occurrence at span as a shorthand field’s.

pub fn has(&self, span: Span, role: Role, target: Target) -> bool

pub fn implement(&mut self, method: DefId, trait_method: (DefId, u32))

Record that method, an impl’s, implements trait_method.

pub fn extend(&mut self, occurrences: impl IntoIterator<Item = Occurrence>)

Record each of occurrences, as Index::record does.

pub fn at( &self, defs: &Definitions, file: FileId, offset: u32, ) -> Option<&Occurrence>

The occurrence at byte offset of file: one whose span holds it, or else one that ends there (spec §3.1). On a shared span the value’s wins, then the type’s, then the trait’s, then a field’s.

pub fn of(&self, target: &Target) -> Vec<&Occurrence>

Every occurrence of target, in recording order.

pub fn declaration(&self, target: &Target) -> Option<&Occurrence>

pub fn family(&self, target: &Target) -> Vec<Target>

target’s family (spec §3.1): a trait method and the impl methods that implement it, the trait’s first; any other target alone.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Self

Returns the “default value” for a type.