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

Class Method

A method, that is, a function with a receiver variable, or a function declared in an interface.

Note that method identity is determined by receiver type identity: if two methods have the same name and their receiver types are identical in the sense of the Go language specification (https://golang.org/ref/spec#Type_identity), then the two methods are identical as well.

Import path

import semmle.go.Scopes

Direct supertypes

Indirect supertypes

Known direct subtypes

Fields

Predicates

getPackage

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

getReceiver

Gets the receiver variable of this method.

getReceiverBaseType

Gets the receiver base type of this method, that is, either the base type of the receiver type if it is a pointer type, or the receiver type itself if it is not a pointer type.

getReceiverType

Gets the type of the receiver variable of this method.

hasQualifiedName

Holds if this method has name m and belongs to the method set of a type T or *T where T has qualified name tp.

hasQualifiedName

Holds if this method has name m and belongs to the method set of a type T or *T where T is declared in package pkg and has name tp.

implements

Holds if this method implements the method m, that is, if m is a method on an interface, and this is a method with the same name on a type that implements that interface.

implements

Holds if this method implements the method that has qualified name pkg.tp.name, that is, if pkg.tp.name is a method on an interface, and this is a method with the same name on a type that implements that interface.

implementsIncludingInterfaceMethods

Holds if this method implements the method m, that is, if m is a method on an interface, and this is a method with the same name on a type that implements that interface.

isInterfaceMethod

Holds if this method is declared in an interface.

Inherited predicates

getACall

Gets a call to this function.

from Function
getAParameter

Gets a parameter of this function.

from Function
getARead

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

from ValueEntity
getAReference

Gets a reference to this entity.

from Entity
getAResult

Gets a result variable of this function.

from Function
getAWrite

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

from ValueEntity
getBody

Gets the body of this function, if any.

from Function
getDeclaration

Gets the declaring identifier for this entity, if any.

from Entity
getFuncDecl

Gets the declaration of this function, if any.

from Function
getName

Gets the name of this entity.

from Entity
getNumParameter

Gets the number of parameters of this function.

from Function
getNumResult

Gets the number of results of this function.

from Function
getParameter

Gets the ith parameter of this function.

from Function
getParameterType

Gets the type of the ith parameter of this function.

from Function
getQualifiedName

Gets the qualified name of this entity, if any.

from Entity
getResult

Gets the ith reslt variable of this function.

from Function
getResultType

Gets the type of the ith result of this function.

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

Holds if this function is variadic.

from Function
mayHaveSideEffects

Holds if this function has no observable side effects.

from Function
mayPanic

Holds if calling this function may cause a runtime panic.

from Function
mayReturnNormally

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

from Function
mustPanic

Holds if calling this function always causes a runtime panic.

from Function
toString

Gets a textual representation of this entity.

from Entity

Charpred