CodeQL library for Rust
codeql/rust-all 0.2.6 (changelog, source)
Search

Class Generated::MacroRules

A macro definition using the macro_rules! syntax.

macro_rules! my_macro {
    () => {
        println!("This is a macro!");
    };
}

INTERNAL: Do not reference the Generated::MacroRules class directly. Use the subclass MacroRules, where the following predicates are available.

Import path

import codeql.rust.elements.internal.generated.MacroRules

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

getAnAttr

Gets any of the attrs of this macro rules.

getAttr

Gets the indexth attr of this macro rules (0-based).

getName

Gets the name of this macro rules, if it exists.

getNumberOfAttrs

Gets the number of attrs of this macro rules.

getTokenTree

Gets the token tree of this macro rules, if it exists.

getVisibility

Gets the visibility of this macro rules, if it exists.

hasName

Holds if getName() exists.

hasTokenTree

Holds if getTokenTree() exists.

hasVisibility

Holds if getVisibility() exists.

Inherited predicates

fromSource

Holds if this element is from source code.

from Locatable
getACfgNode

Gets a control flow node for this AST node, if any.

from AstNode
getAttributeMacroExpansion

Gets the attribute macro expansion of this item, if it exists.

from Item
getCanonicalPath

Gets the canonical path of this item, if any.

from Addressable
getCanonicalPath

Gets the canonical path of this item, if any.

from Addressable
getEnclosingBlock

Gets the block that encloses this node, if any.

from AstNode
getEnclosingCallable

Gets the immediately enclosing callable of this node, if any.

from AstNode
getEnclosingCfgScope

Gets the CFG scope that encloses this node, if any.

from AstNode
getFile

Gets the primary file where this element occurs.

from Locatable
getLocationfrom Locatable
getParentNode

Gets the nearest enclosing parent of this node, which is also an AstNode, if any.

from AstNode
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Element
getResolveStep

Gets the most immediate element that should substitute this element in the explicit AST, if any. Classes can override this to indicate this node should be in the “hidden” AST, mostly reserved for conversions and syntactic sugar nodes like parentheses.

from Element
hasAttributeMacroExpansion

Holds if getAttributeMacroExpansion() exists.

from Item
hasCanonicalPath

Holds if this item has a canonical path.

from Addressable
hasEnclosingCfgScope

Holds if this node is inside a CFG scope.

from AstNode
isFromMacroExpansion

Holds if this node exists only as the result of a macro expansion.

from AstNode
isInMacroExpansion

Holds if this node is inside a macro expansion.

from AstNode
isUnknownfrom Element
resolve

Gets the element that should substitute this element in the explicit AST, applying getResolveStep transitively.

from Element
toAbbreviatedString

INTERNAL: Do not use.

from Element
toString

Gets the string representation of this element.

from Element
toStringImpl

INTERNAL: Do not use.

from Element