Struct MacroCallId 

pub struct MacroCallId(pub(crate) Id, pub(crate) PhantomData<fn() -> &'static ()>);

Macro ids. That’s probably the tricksiest bit in rust-analyzer, and the reason why we use salsa at all.

We encode macro definitions into ids of macro calls, this what allows us to be incremental.

Tuple Fields

0: Id

1: PhantomData<fn() -> &'static ()>

Implementations

impl MacroCallId

pub fn expansion_span_map(self, db: &dyn SourceDatabase) -> &ExpansionSpanMap

impl MacroCallId

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

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

pub fn parent(self, db: &dyn SourceDatabase) -> HirFileId

pub fn expansion_info(self, db: &dyn SourceDatabase) -> ExpansionInfo<'_>

Return expansion information if it is a macro-expansion file

pub fn kind(self, db: &dyn SourceDatabase) -> MacroKind

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

pub fn is_include_like_macro(self, db: &dyn SourceDatabase) -> bool

pub fn is_env_or_option_env(self, db: &dyn SourceDatabase) -> bool

pub fn is_eager(self, db: &dyn SourceDatabase) -> bool

pub fn eager_arg(self, db: &dyn SourceDatabase) -> Option<MacroCallId>

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

impl MacroCallId

pub fn parse_macro_expansion<'db>( self: MacroCallId, db: &'db dyn SourceDatabase, ) -> &'db ExpandResult<(Parse<SyntaxNode>, ExpansionSpanMap)>

Implementation of HirFileId::parse_or_expand for the macro case.

pub fn parse_macro_expansion_error( self, db: &dyn SourceDatabase, ) -> Option<ExpandResult<Arc<[SyntaxError]>>>

pub fn macro_arg_considering_derives<'db>( self, db: &'db dyn SourceDatabase, kind: &MacroCallKind, ) -> &'db (TopSubtree, SyntaxFixupUndoInfo, Span)

This resolves the MacroCallId to check if it is a derive macro if so get the macro_arg for the derive. Other wise return the macro_arg for the macro_call_id.

This is not connected to the database so it does not cache the result. However, the inner macro_arg query is

pub(crate) fn macro_arg<'db>( self: MacroCallId, db: &'db dyn SourceDatabase, ) -> &'db (TopSubtree, SyntaxFixupUndoInfo, Span)

Lowers syntactic macro call to a token tree representation. That’s a firewall query, only typing in the macro call itself changes the returned subtree.

pub(crate) fn macro_expand<'db>( self, db: &'db dyn SourceDatabase, loc: &MacroCallLoc, ) -> ExpandResult<(Cow<'db, TopSubtree>, MatchedArmIndex)>

pub(crate) fn expand_proc_macro<'db>( self: MacroCallId, db: &'db dyn SourceDatabase, ) -> &'db ExpandResult<TopSubtree>

Special case of Self::macro_expand for procedural macros. We can’t LRU proc macros, since they are not deterministic in general, and non-determinism breaks salsa in a very, very, very bad way. @edwin0cheng heroically debugged this once! See #4315 for details

impl MacroCallId

pub fn expand_speculative( self, db: &dyn SourceDatabase, speculative_args: &SyntaxNode, token_to_map: SyntaxToken, ) -> Option<(SyntaxNode, Vec<(SyntaxToken, u8)>)>

This expands the given macro call, but with different arguments. This is used for completion, where we want to see what ‘would happen’ if we insert a token. The token_to_map mapped down into the expansion, with the mapped token(s) returned with their priority.

impl MacroCallId

pub fn ingredient(zalsa: &Zalsa) -> &IngredientImpl<Self>

impl<'db> MacroCallId

pub fn new<Db_, T0: Lookup<MacroCallLoc> + Hash>(db: &'db Db_, loc: T0) -> Self

where Db_: ?Sized + Database, MacroCallLoc: HashEqLike<T0>,

pub fn loc<Db_>(self, db: &'db Db_) -> &'db MacroCallLoc

where Db_: ?Sized + Database,

impl MacroCallId

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'db> MacroCallLoc: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

Trait Implementations

impl AsId for MacroCallId

fn as_id(&self) -> Id

impl Clone for MacroCallId

fn clone(&self) -> MacroCallId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for MacroCallId

const LOCATION: Location

const DEBUG_NAME: &'static str = "MacroCallId"

const PERSIST: bool = false

Whether this struct should be persisted with the database.

const REVISIONS: NonZeroUsize

type Fields<'a> = (MacroCallLoc,)

The fields of the struct being interned.

type Struct<'db> = MacroCallId

The end user struct

fn serialize<S: Serializer>( fields: &Self::Fields<'_>, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

fn deserialize<'de, D: Deserializer<'de>>( deserializer: D, ) -> Result<Self::Fields<'static>, D::Error>

Deserialize the fields using serde.

fn heap_size(_value: &Self::Fields<'_>) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

impl Debug for MacroCallId

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

Formats the value using the given formatter.

impl FileIdToSyntax for MacroCallId

fn file_syntax(self, db: &dyn SourceDatabase) -> SyntaxNode

impl From<MacroCallId> for HirFileId

fn from(file_id: MacroCallId) -> Self

Converts to this type from the input type.

impl From<MacroCallId> for MacroCallId

fn from(value: MacroCallId) -> Self

Converts to this type from the input type.

impl From<MacroCallId> for MacroCallId

fn from(value: MacroCallId) -> MacroCallId

Converts to this type from the input type.

impl FromId for MacroCallId

fn from_id(id: Id) -> Self

impl HasJar for MacroCallId

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<MacroCallId>

The [Jar] associated with this ingredient.

impl Hash for MacroCallId

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

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 Lookup for MacroCallId

type Data = MacroCallLoc

fn lookup<'db>(&self, db: &'db dyn SourceDatabase) -> &'db Self::Data

impl PartialEq for MacroCallId

fn eq(&self, other: &MacroCallId) -> 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 SalsaStructInDb for MacroCallId

const LEAF_TYPE_IDS: &'static [ConstTypeId]

The type IDs of all concrete (leaf) salsa struct types that this type can contain.

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl Update for MacroCallId

unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool

Returns

impl Copy for MacroCallId

impl Eq for MacroCallId

impl Send for MacroCallId

impl StructuralPartialEq for MacroCallId

impl Sync for MacroCallId