Skip to main content

HirFileId

Enum HirFileId 

pub enum HirFileId {
    FileId(EditionedFileId),
    MacroFile(MacroCallId),
}

Variants§

Implementations§

§

impl HirFileId

pub fn span_map<'db>( self, db: &'db (dyn SourceDatabase + 'static), ) -> SpanMap<'db>

§

impl HirFileId

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

pub fn is_macro(self) -> bool

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

pub fn syntax_context( self, db: &(dyn SourceDatabase + 'static), edition: Edition, ) -> SyntaxContext

pub fn edition(self, db: &(dyn SourceDatabase + 'static)) -> Edition

pub fn original_file( self, db: &(dyn SourceDatabase + 'static), ) -> EditionedFileId

pub fn original_file_respecting_includes( self, db: &(dyn SourceDatabase + 'static), ) -> EditionedFileId

pub fn original_call_node( self, db: &(dyn SourceDatabase + 'static), ) -> Option<InFileWrapper<EditionedFileId, SyntaxNode<RustLanguage>>>

pub fn call_node( self, db: &(dyn SourceDatabase + 'static), ) -> Option<InFileWrapper<HirFileId, SyntaxNode<RustLanguage>>>

pub fn as_builtin_derive_attr_node( &self, db: &(dyn SourceDatabase + 'static), ) -> Option<InFileWrapper<HirFileId, Attr>>

pub fn parse_or_expand( self, db: &(dyn SourceDatabase + 'static), ) -> SyntaxNode<RustLanguage>

Main public API – parses a hir file, not caring whether it’s a real file or a macro expansion.

pub fn macro_expansion_depth(self, db: &(dyn SourceDatabase + 'static)) -> u32

How many macro expansions separate this file from the real file it originates from.

Expander and DefCollector seed their expansion depth counters from this. Both otherwise start at zero for every body and every block, so a macro expanding to an item that invokes the macro again advances neither counter past one and never reaches the recursion limit.

Written recursively rather than as a loop so that salsa memoizes each file’s depth. Callers ask for this once per body, and the bodies of one expansion chain sit at depths 1..n, so a loop would walk 1 + 2 + … + n steps for that chain. Reusing the parent’s memoized depth makes each file O(1) once computed, and the chain linear.

§

impl HirFileId

pub fn ast_id_map<'db>( self, db: &'db (dyn SourceDatabase + 'static), ) -> &'db AstIdMap

Trait Implementations§

§

impl Clone for HirFileId

§

fn clone(&self) -> HirFileId

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for HirFileId

§

impl Debug for HirFileId

§

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

Formats the value using the given formatter. Read more
§

impl Eq for HirFileId

§

impl From<EditionedFileId> for HirFileId

§

fn from(file_id: EditionedFileId) -> HirFileId

Converts to this type from the input type.
§

impl From<MacroCallId> for HirFileId

§

fn from(file_id: MacroCallId) -> 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. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for HirFileId

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, R> CollectAndApply<T, R> for T

§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> HashEqLike<&T> for T
where T: Hash + Eq,

§

fn hash<H>(&self, h: &mut H)
where H: Hasher,

§

fn eq(&self, data: &&T) -> bool

§

impl<T> HashEqLike<Cow<'_, T>> for T
where T: Hash + Eq + Clone,

§

fn hash<H>(&self, h: &mut H)
where H: Hasher,

§

fn eq(&self, data: &Cow<'_, T>) -> bool

§

impl<T> HashEqLike<T> for T
where T: Hash + Eq,

§

fn hash<H>(&self, h: &mut H)
where H: Hasher,

§

fn eq(&self, data: &T) -> bool

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoBox<dyn Any + Send + Sync> for T
where T: Any + Send + Sync,

§

fn into_box(self) -> Box<dyn Any + Send + Sync>

Convert self into the appropriate boxed form.
§

impl<T> IntoBox<dyn Any + Send> for T
where T: Any + Send,

§

fn into_box(self) -> Box<dyn Any + Send>

Convert self into the appropriate boxed form.
§

impl<T> IntoBox<dyn Any> for T
where T: Any,

§

fn into_box(self) -> Box<dyn Any>

Convert self into the appropriate boxed form.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Lookup<T> for T

§

fn into_owned(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

§

fn upcast(self, interner: I) -> U

§

impl<I, T> UpcastFrom<I, T> for T

§

fn upcast_from(from: T, _tcx: I) -> T

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more