FunctionDecl Structure Reference


                    
                    
                    constructDescription

Declaration

Swift

public static let constructDescription: String

Show on GitHub


                    
                    
                    isCallable

Declaration

Swift

public static let isCallable: Bool

Show on GitHub


                    
                    
                    site

Declaration

Swift

public let site: SourceRange

Show on GitHub


                    
                    
                    introducerSite

The site of the fun introducer.

Declaration

Swift

public let introducerSite: SourceRange

Show on GitHub


                    
                    
                    attributes

The attributes of the declaration.

Declaration

Swift

public let attributes: [SourceRepresentable<Attribute>]

Show on GitHub


                    
                    
                    accessModifier

The access modifier of the declaration, if any.

Declaration

Swift

public let accessModifier: SourceRepresentable<AccessModifier>

Show on GitHub


                    
                    
                    memberModifier

The member modifier of the declaration.

Declaration

Swift

public let memberModifier: SourceRepresentable<MemberModifier>?

Show on GitHub


                    
                    
                    receiverEffect

The access effect of the function’s receiver.

Declaration

Swift

public let receiverEffect: SourceRepresentable<AccessEffect>?

Show on GitHub


                    
                    
                    notation

The operator notation of the function.

Declaration

Swift

public let notation: SourceRepresentable<OperatorNotation>?

Show on GitHub


                    
                    
                    identifier

The identifier of the function, if any.

Declaration

Swift

public let identifier: SourceRepresentable<Identifier>?

Show on GitHub


                    
                    
                    genericClause

The generic clause of the declaration, if any.

Declaration

Swift

public let genericClause: SourceRepresentable<GenericClause>?

Show on GitHub


                    
                    
                    explicitCaptures

The explicit capture declarations of the function.

Declaration

Swift

public let explicitCaptures: [BindingDecl.ID]

Show on GitHub


                    
                    
                    parameters

The parameters of the function.

All parameters must have a type annotation unless isInExprContext is true.

Declaration

Swift

public let parameters: [ParameterDecl.ID]

Show on GitHub


                    
                    
                    receiver

The declaration of the implicit receiver parameter, if any.

Declaration

Swift

public let receiver: ParameterDecl.ID?

Show on GitHub


                    
                    
                    output

The return type annotation of the function, if any.

Declaration

Swift

public let output: AnyExprID?

Show on GitHub


                    
                    
                    body

The body of the declaration, if any.

Declaration

Swift

public let body: FunctionBody?

Show on GitHub


                    
                    
                    isInExprContext

Indicates whether the declaration appears in an expression context.

Declaration

Swift

public let isInExprContext: Bool

Show on GitHub

api

Properties about the API described by the function.

Declaration

Swift

public let api: APIFlags

Show on GitHub


                    
                    
                    init(introducerSite:attributes:accessModifier:memberModifier:receiverEffect:notation:identifier:genericClause:explicitCaptures:parameters:receiver:output:body:isInExprContext:site:)

Creates an instance with the given properties.

Declaration

Swift

public init(
  introducerSite: SourceRange,
  attributes: [SourceRepresentable<Attribute>] = [],
  accessModifier: SourceRepresentable<AccessModifier>,
  memberModifier: SourceRepresentable<MemberModifier>? = nil,
  receiverEffect: SourceRepresentable<AccessEffect>? = nil,
  notation: SourceRepresentable<OperatorNotation>? = nil,
  identifier: SourceRepresentable<Identifier>? = nil,
  genericClause: SourceRepresentable<GenericClause>? = nil,
  explicitCaptures: [BindingDecl.ID] = [],
  parameters: [ParameterDecl.ID] = [],
  receiver: ParameterDecl.ID? = nil,
  output: AnyExprID? = nil,
  body: FunctionBody? = nil,
  isInExprContext: Bool = false,
  site: SourceRange
)

Show on GitHub


                    
                    
                    isDefinition

true iff self is a definition of the entity that it declares.

Declaration

Swift

public var isDefinition: Bool { get }

Show on GitHub


                    
                    
                    isStatic

true iff self denotes a static member function.

Declaration

Swift

public var isStatic: Bool { get }

Show on GitHub


                    
                    
                    isInout

true iff self denotes an inout member function.

Declaration

Swift

public var isInout: Bool { get }

Show on GitHub


                    
                    
                    isSink

true iff self denotes a sink member function.

Declaration

Swift

public var isSink: Bool { get }

Show on GitHub


                    
                    
                    isDeinit

true iff self denotes a deinitializer.

Declaration

Swift

public var isDeinit: Bool { get }

Show on GitHub


                    
                    
                    isForeignInterface

true iff self is a foreign function interface.

Declaration

Swift

public var isForeignInterface: Bool { get }

Show on GitHub


                    
                    
                    isExternal

self iff self declares a function whose implementation is defined externally.

Declaration

Swift

public var isExternal: Bool { get }

Show on GitHub


                    
                    
                    sourcesOfImplicitCaptures

The part of the declaration that may have implicit captures.

Declaration

Swift

public var sourcesOfImplicitCaptures: [AnyNodeID] { get }

Show on GitHub


                    
                    
                    validateForm(in:reportingDiagnosticsTo:)

Declaration

Swift

public func validateForm(in ast: AST, reportingDiagnosticsTo log: inout DiagnosticSet)

Show on GitHub


                    
                    
                    APIFlags

A set of properties about the API described by a function declaration.

Declaration

Swift

public struct APIFlags : OptionSet, Codable, RawRepresentable, Sendable

Show on GitHub