SKCodeCompletion

open class SKCodeCompletion : Codable

Represents a SourceKit code completion request that provides code completion suggestions.

Public Type Aliases


                    
                    
                    Item

Undocumented

Declaration

Swift

public typealias Item = SKCodeCompletionItem

Public Stored Properties

nextRequestStart
The value to use for SKCodeCompletionSession.Options.requestStart in the next request when using SKCodeCompletionSession.Options.requestLimit.

Note
Only present for SKCodeCompletionSession requests.
Declaration
Swift

public let nextRequestStart: Int?
items
The code completion items for the request.
Declaration
Swift

public var items: [Item]

Public Initializers


                    
                    
                    init(file:offset:compilerArguments:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

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 (e.g `["-sdk", "/path/to/sdk"]`).


                    
                    
                    init(file:offset:sdkPath:target:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

Parameters

`file`	The source file.
`offset`	The byte offset of the 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(filePath:offset:compilerArguments:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

Parameters

`filePath`	The absolute file path to 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 (e.g `["-sdk", "/path/to/sdk"]`).


                    
                    
                    init(contents:offset:compilerArguments:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

Parameters

`contents`	The source code contents.
`offset`	The byte offset of the code completion point inside the source contents.
`compilerArguments`	The compiler arguments used to build the module (e.g `["-sdk", "/path/to/sdk"]`).


                    
                    
                    init(filePath:offset:sdkPath:target:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

Parameters

`filePath`	The absolute file path to the source file.
`offset`	The byte offset of the 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:)

Creates a new synchronous SourceKit code completion request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Declaration

Swift

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

Parameters

`contents`	The source code contents.
`offset`	The byte offset of the 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"`).

Equatable Protocol


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: SKCodeCompletion, rhs: SKCodeCompletion) -> Bool