CodeQL library for Swift
codeql/swift-all 3.0.1-dev (changelog, source)
Search

Class Generated::StructType

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

Import path

import codeql.swift.generated.type.StructType

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

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

Inherited predicates

getABaseType

Gets any base type of this type. Expands protocols added in extensions and expands type aliases. For example in the following code, B has base type A:

from Type
getADerivedType

Gets a type derived from this type. Expands type aliases, for example in the following code, B derives from type A.

from Type
getCanonicalType

Gets the canonical type of this type.

from Type
getDeclaration

Gets the declaration of this any generic type.

from AnyGenericType
getFullName

Gets the full name of this Type. For example in: swift struct A { struct B { // ... } } The name and full name of A is A. The name of B is B, but the full name of B is A.B.

from Type
getFullyUnresolvedfrom Element
getImmediateCanonicalType

Gets the canonical type of this type.

from Type
getImmediateParent

Gets the parent of this any generic type, if it exists.

from AnyGenericType
getName

Gets the name of this type.

from Type
getParent

Gets the parent of this any generic type, if it exists.

from AnyGenericType
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
getUnderlyingType

Gets this type after any type aliases have been resolved. For example in the following code, the underlying type of MyInt is Int: typealias MyInt = Int

from Type
hasParent

Holds if getParent() exists.

from AnyGenericType
isUnknown

Holds if this element is unknown.

from Element
resolve

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

from Element
toString

Gets the string representation of this element.

from Type