Struct ra_ap_hir::HirFileId

pub struct HirFileId(_);

Input to the analyzer is a set of files, where each file is identified by FileId and contains source code. However, another source of source code in Rust are macros: each macro can be thought of as producing a “temporary file”. To assign an id to such a file, we use the id of the macro call that produced the file. So, a HirFileId is either a FileId (source code written by user), or a MacroCallId (source code produced by macro).

What is a MacroCallId? Simplifying, it’s a HirFileId of a file containing the call plus the offset of the macro call in the file. Note that this is a recursive definition! However, the size_of of HirFileId is finite (because everything bottoms out at the real FileId) and small (MacroCallId uses the location interning. You can check details here: https://en.wikipedia.org/wiki/String_interning).

Implementations

impl HirFileId

pub fn original_file(self, db: &dyn AstDatabase) -> FileId

For macro-expansion files, returns the file original source file the expansion originated from.

pub fn expansion_level(self, db: &dyn AstDatabase) -> u32

pub fn call_node(
    self,
    db: &dyn AstDatabase
) -> Option<InFile<SyntaxNode<RustLanguage>>>

If this is a macro call, returns the syntax node of the call.

pub fn expansion_info(self, db: &dyn AstDatabase) -> Option<ExpansionInfo>

Return expansion information if it is a macro-expansion file

pub fn is_builtin_derive(&self, db: &dyn AstDatabase) -> Option<InFile<Item>>

Indicate it is macro file generated for builtin derive

pub fn is_include_macro(&self, db: &dyn AstDatabase) -> bool

Return whether this file is an include macro

Trait Implementations

impl Clone for HirFileId

pub fn clone(&self) -> HirFileId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HirFileId

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

Formats the value using the given formatter.

impl From<FileId> for HirFileId

pub fn from(id: FileId) -> HirFileId

Performs the conversion.

impl From<MacroFile> for HirFileId

pub fn from(id: MacroFile) -> HirFileId

Performs the conversion.

impl Hash for HirFileId

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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 PartialEq<HirFileId> for HirFileId

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

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

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

This method tests for !=.

impl Copy for HirFileId

impl Eq for HirFileId

impl StructuralEq for HirFileId

impl StructuralPartialEq for HirFileId