Class Impl::TypeDecl

A Swift type declaration, for example a class, struct, enum or protocol declaration.

Type declarations are distinct from types. A type declaration represents the code that declares a type, for example:

class MyClass {
  ...
}

Not all types have type declarations, for example built-in types do not have type declarations.

Import path

import codeql.swift.elements.decl.internal.TypeDeclImpl

Direct supertypes

TypeDecl

Indirect supertypes

Known direct subtypes

Predicates

getABaseType	Gets any of the base types of this type declaration. Expands protocols added in extensions and expands type aliases. For example in the following code, `B` has base type `A`:
getABaseTypeDecl	Gets the declaration of any of the base types of this type declaration. Expands protocols added in extensions and expands type aliases. For example in the following code, `B` has base type `A`.
getADerivedTypeDecl	Gets the declaration of any type derived from this type declaration. Expands protocols added in extensions and expands type aliases. For example in the following code, `B` is derived from `A`.
getBaseType	Gets the `index`th base type of this type declaration (0-based). This is the same as `getInheritedType`. DEPRECATED: use `getInheritedType` or unindexed `getABaseType`.
getBaseTypeDecl	Gets the declaration of the `index`th base type of this type declaration (0-based). DEPRECATED: The index is not very meaningful here. Use `getABaseTypeDecl`.
getFullName	Gets the full name of this `TypeDecl`. 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`.
getImmediateBaseType	Gets the `index`th base type of this type declaration (0-based).
toString	Gets the string representation of this element.

Inherited predicates

asCapturedDecl	Gets a capture of this declaration in the scope of a closure.	from ValueDecl
asNominalTypeDecl	Gets the `NominalTypeDecl` corresponding to this `Decl`, if any. This resolves an `ExtensionDecl` to the `NominalTypeDecl` that it extends.	from Decl
getAMember	Gets any of the members of this declaration.	from Decl
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this element belongs.	from Element
getAnAccess	Gets an expression that references this declaration.	from ValueDecl
getAnInheritedType	Gets any of the inherited types of this type declaration.	from TypeDecl
getDeclaringDecl	Gets the declaration that declares this declaration as a member, if any.	from Decl
getEnclosingCallable	Gets the nearest `Callable` that contains this AST node, if any. This includes (auto)closures, functions, methods, (de)initializers, and accessors.	from AstNode
getEnclosingDecl	Gets the nearest declaration that contains this AST node, if any.	from AstNode
getEnclosingFunction	Gets the nearest function definition that contains this AST node, if any. This includes functions, methods, (de)initializers, and accessors, but not closures.	from AstNode
getFile	Gets the primary file where this element occurs.	from Locatable
getFullyUnresolved		from Element
getImmediateInheritedType	Gets the `index`th inherited type of this type declaration (0-based).	from TypeDecl
getImmediateInterfaceType	Gets the interface type of this value declaration.	from ValueDecl
getInheritedType	Gets the `index`th inherited type of this type declaration (0-based).	from TypeDecl
getInterfaceType	Gets the interface type of this value declaration.	from ValueDecl
getLocation	Gets the location associated with this element in the code, if it exists.	from Locatable
getMember	Gets the `index`th member of this declaration (0-based).	from Decl
getModule	Gets the module of this declaration.	from Decl
getName	Gets the name of this type declaration.	from TypeDecl
getNumberOfInheritedTypes	Gets the number of inherited types of this type declaration.	from TypeDecl
getNumberOfMembers	Gets the number of members of this declaration.	from Decl
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
hasLocation	Holds if `getLocation()` exists.	from Locatable
isCaptured	Holds if this declaration is captured by a closure.	from ValueDecl
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