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).

The two variants are encoded in a single u32 which are differentiated by the MSB. If the MSB is 0, the value represents a FileId, otherwise the remaining 31 bits represent a MacroCallId.

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 original_call_node(
    self,
    db: &dyn AstDatabase
) -> Option<(FileId, SyntaxNode<RustLanguage>)>

If this is a macro call, returns the syntax node of the very first macro call this file resides in.

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<Attr>>

Indicate it is macro file generated for builtin derive

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

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

Return whether this file is an include macro

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

Return whether this file is an attr macro

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

Return whether this file is the pseudo expansion of the derive attribute. See [crate::builtin_attr_macro::derive_attr_expand].

pub fn is_macro(self) -> bool

pub fn macro_file(self) -> Option<MacroFile>

pub fn file_id(self) -> Option<FileId>

Trait Implementations

impl Clone for HirFileId

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

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

Formats the value using the given formatter.

impl From<FileId> for HirFileId

fn from(_: FileId) -> HirFileId

Converts to this type from the input type.

impl From<MacroFile> for HirFileId

fn from(_: MacroFile) -> HirFileId

Converts to this type from the input type.

impl Hash for HirFileId

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<HirFileId> for HirFileId

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for HirFileId

impl Eq for HirFileId

impl StructuralEq for HirFileId

impl StructuralPartialEq for HirFileId