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

Class Impl::Function

A function declaration. For example

fn foo(x: u32) -> u64 {(x + 1).into()}

A function declaration within a trait might not have a body:

trait Trait {
    fn bar();
}

Import path

import codeql.rust.elements.internal.FunctionImpl

Direct supertypes

Indirect supertypes

Predicates

getAPrecedingComment

Gets a comment preceding this function.

getPrecedingComment

Gets a comment preceding this function.

toStringImpl

INTERNAL: Do not use.

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
getAParam

Gets any of the parameters of this callable.

from Callable
getAPrimaryQlClass

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

from Function
getAbi

Gets the abi of this function, if it exists.

from Function
getAnAttr

Gets any of the attrs of this callable.

from Callable
getAttr

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

from Callable
getAttributeMacroExpansion

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

from Item
getBody

Gets the body of this function, if it exists.

from Function
getCanonicalPath

Gets the canonical path of this item, if any.

from Addressable
getCanonicalPath

Gets the canonical path of this item, if any.

from Addressable
getCrateOrigin

Gets the crate origin of this addressable, if it exists.

from Addressable
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
getExtendedCanonicalPath

Gets the extended canonical path of this addressable, if it exists.

from Addressable
getFile

Gets the primary file where this element occurs.

from Locatable
getGenericParamList

Gets the generic parameter list of this function, if it exists.

from Function
getLocationfrom Locatable
getName

Gets the name of this function, if it exists.

from Function
getNumberOfAttrs

Gets the number of attrs of this callable.

from Callable
getNumberOfParams

Gets the number of parameters of this callable.

from Callable
getParam

Gets the indexth parameter of this callable (0-based).

from Callable
getParamList

Gets the parameter list of this callable, if it exists.

from Callable
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
getRetType

Gets the ret type of this function, if it exists.

from Function
getVisibility

Gets the visibility of this function, if it exists.

from Function
getWhereClause

Gets the where clause of this function, if it exists.

from Function
hasAbi

Holds if getAbi() exists.

from Function
hasAttributeMacroExpansion

Holds if getAttributeMacroExpansion() exists.

from Item
hasBody

Holds if getBody() exists.

from Function
hasCanonicalPath

Holds if this item has a canonical path.

from Addressable
hasCrateOrigin

Holds if getCrateOrigin() exists. INTERNAL: Do not use.

from Addressable
hasExtendedCanonicalPath

Holds if getExtendedCanonicalPath() exists. INTERNAL: Do not use.

from Addressable
hasGenericParamList

Holds if getGenericParamList() exists.

from Function
hasImplementation

Holds if this function has an implementation.

from Function
hasName

Holds if getName() exists.

from Function
hasParamList

Holds if getParamList() exists.

from Callable
hasRetType

Holds if getRetType() exists.

from Function
hasVisibility

Holds if getVisibility() exists.

from Function
hasWhereClause

Holds if getWhereClause() exists.

from Function
isAsync

Holds if this function is async.

from Function
isConst

Holds if this function is const.

from Function
isDefault

Holds if this function is default.

from Function
isFromMacroExpansion

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

from AstNode
isGen

Holds if this function is gen.

from Function
isInMacroExpansion

Holds if this node is inside a macro expansion.

from AstNode
isUnknownfrom Element
isUnsafe

Holds if this function is unsafe.

from Function
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