CodeQL library for Go
codeql/go-all 2.1.3 (changelog, source)
Search

Class Function

A built-in or declared function.

Import path

import semmle.go.Scopes

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getACall

Gets a call to this function.

getAParameter

Gets a parameter of this function.

getAResult

Gets a result variable of this function.

getBody

Gets the body of this function, if any.

getFuncDecl

Gets the declaration of this function, if any.

getNumParameter

Gets the number of parameters of this function.

getNumResult

Gets the number of results of this function.

getParameter

Gets the ith parameter of this function.

getParameterType

Gets the type of the ith parameter of this function.

getResult

Gets the ith reslt variable of this function.

getResultType

Gets the type of the ith result of this function.

isVariadic

Holds if this function is variadic.

mayHaveSideEffects

Holds if this function has no observable side effects.

mayPanic

Holds if calling this function may cause a runtime panic.

mayReturnNormally

Holds if this function may return without panicking, exiting the process, or looping forever.

mustPanic

Holds if calling this function always causes a runtime panic.

Inherited predicates

getARead

Gets a data-flow node that reads the value of this entity.

from ValueEntity
getAReference

Gets a reference to this entity.

from Entity
getAWrite

Gets a control-flow node that updates the value of this entity.

from ValueEntity
getDeclaration

Gets the declaring identifier for this entity, if any.

from Entity
getName

Gets the name of this entity.

from Entity
getPackage

Gets the package in which this entity is declared, if any.

from Entity
getQualifiedName

Gets the qualified name of this entity, if any.

from Entity
getScope

Gets the scope in which this entity is declared, if any.

from Entity
getType

Gets the type of this entity.

from Entity
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

from Entity
hasQualifiedName

Holds if this entity is declared in a package with path pkg and has the given name.

from Entity
toString

Gets a textual representation of this entity.

from Entity