SKCodeCompletionSession

open class SKCodeCompletionSession : NSObject

Represents a SourceKit code completion session, which can be filtered using update requests.

Public Type Aliases


                    
                    
                    CompletionHandler

Undocumented

Declaration

Swift

public typealias CompletionHandler = (SKCodeCompletionSession, Response) -> Void


                    
                    
                    ErrorHandler

Undocumented

Declaration

Swift

public typealias ErrorHandler = (SKCodeCompletionSession, Response, SKError) -> Void


                    
                    
                    Options

Undocumented

Declaration

Swift

public typealias Options = SKCodeCompletionSessionOptions


                    
                    
                    Response

Undocumented

Declaration

Swift

public typealias Response = SKCodeCompletionSessionResponse

Public Stored Properties

file
The session source file.
Declaration
Swift

public let file: File
offset
The byte offset of the code completion point inside the session’s source contents.
Declaration
Swift

public let offset: Offset
options
The mutable code completion session options.

These options can (should) be modified before sending an update().
Declaration
Swift

public var options: SKCodeCompletionSession.Options?
cancelOnSubsequentRequest
Whether previous requests should be canceled if a new request is made that uses different options.

Note
The previous requests are not actually canceled (because they are asynchronous, and that ship has sailed); however, the completion handler will only be called with the response of the most recently sent request.
Declaration
Swift

public var cancelOnSubsequentRequest: Bool
completionHandler
A closure that receives the code completion request responses.
Declaration
Swift

public var completionHandler: SKCodeCompletionSession.CompletionHandler?
errorHandler
A closure that receives any code completion request errors.
Declaration
Swift

public var errorHandler: SKCodeCompletionSession.ErrorHandler?
isOpen
Whether the session is open.

This boolean indicates whether the session has been opened (open()) and not closed (close()).
Declaration
Swift

public internal(set) var isOpen: Bool
latestResponse
The most recent request response received in the session.
Declaration
Swift

public internal(set) var latestResponse: SKCodeCompletionSession.Response?

Public Computed Properties

isActive
Whether there are any outstanding session requests awaiting completion.
Declaration
Swift

public var isActive: Bool { get }
isClosed
Whether the session has been closed (close()).

Note
This property will also be false if the session has not yet been opened (open()).
Declaration
Swift

public var isClosed: Bool { get }
queueRequestCount
The number of outstanding session requests awaiting completion.
Declaration
Swift

public var queueRequestCount: Int { get }

Public Initializers


                    
                    
                    init(file:offset:compilerArguments:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public init(file: File,
            offset: Offset,
            compilerArguments: [String])

Parameters

`file`	The source file.
`offset`	The byte offset of the code completion point inside the source contents.
`compilerArguments`	The compiler arguments used to build the module.


                    
                    
                    init(file:offset:sdkPath:target:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public convenience init(file: File,
                        offset: Offset,
                        sdkPath: String,
                        target: String? = nil)

Parameters

`file`	The source file.
`offset`	The source code byte offset to use in the SourceKit request.
`sdkPath`	The path to the SDK to compile against.
`target`	The target (triple) architecture to generate completions for (e.g. `"arm64-apple-ios12.1"`).


                    
                    
                    init(filePath:offset:compilerArguments:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public convenience init(filePath: String,
                        offset: Offset,
                        compilerArguments: [String])

Parameters

`filePath`	The file path of the source file.
`offset`	The byte offset of code completion point inside the source contents.
`compilerArguments`	The compiler arguments used to build the module.


                    
                    
                    init(contents:offset:compilerArguments:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public convenience init(contents: String,
                        offset: Offset,
                        compilerArguments: [String])

Parameters

`contents`	The source code contents.
`offset`	The byte offset of code completion point inside the source contents.
`compilerArguments`	The compiler arguments used to build the module.


                    
                    
                    init(filePath:offset:sdkPath:target:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public convenience init(filePath: String,
                        offset: Offset,
                        sdkPath: String,
                        target: String? = nil)

Parameters

`filePath`	The file path of the source file.
`offset`	The byte offset of code completion point inside the source contents.
`sdkPath`	The path to the SDK to compile against.
`target`	The target (triple) architecture to generate completions for (e.g. `"arm64-apple-ios12.1"`).


                    
                    
                    init(contents:offset:sdkPath:target:)

Initializes a new SourceKit code completion session object.

Note

This request needs to be opened (via the open() method).

Declaration

Swift

public convenience init(contents: String,
                        offset: Offset,
                        sdkPath: String,
                        target: String? = nil)

Parameters

`contents`	The source contents.
`offset`	The byte offset of code completion point inside the source contents.
`sdkPath`	The path to the SDK to compile against.
`target`	The target (triple) architecture to generate completions for (e.g. `"arm64-apple-ios12.1"`).

Public Request Methods

open()
Opens the code completion session for the file at the byte offset with the specified options.
Declaration
Swift

public func open()
update()
Updates an open code completion session with the specified options.
Declaration
Swift

public func update()
close()
Closes an opened code completion session.
Declaration
Swift

public func close()