Struct hir::HirFileId

pub struct HirFileId(/* private fields */);

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 is_macro(self) -> bool

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

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

pub fn repr(self) -> HirFileIdRepr

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

fn from(id: EditionedFileId) -> HirFileId

Converts to this type from the input type.

impl From<MacroCallId> for HirFileId

fn from(value: MacroCallId) -> HirFileId

Converts to this type from the input type.

impl From<MacroFileId> for HirFileId

fn from(_: MacroFileId) -> 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 HirFileIdExt for HirFileId

fn edition(self, db: &dyn ExpandDatabase) -> Edition

fn original_file(self, db: &dyn ExpandDatabase) -> EditionedFileId

Returns the original file of this macro call hierarchy.

fn original_file_respecting_includes( self, db: &dyn ExpandDatabase, ) -> EditionedFileId

Returns the original file of this macro call hierarchy while going into the included file if one of the calls comes from an `include!``.

fn original_call_node( self, db: &dyn ExpandDatabase, ) -> Option<InFileWrapper<EditionedFileId, SyntaxNode<RustLanguage>>>

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

fn as_builtin_derive_attr_node( &self, db: &dyn ExpandDatabase, ) -> Option<InFileWrapper<HirFileId, Attr>>

impl Ord for HirFileId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<EditionedFileId> for HirFileId

fn eq(&self, _: &EditionedFileId) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<FileId> for HirFileId

fn eq(&self, _: &FileId) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for HirFileId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for HirFileId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for HirFileId

impl Eq for HirFileId

impl StructuralPartialEq for HirFileId