api / org.gradle.language.swift / SwiftBinary

SwiftBinary

@Incubating interface SwiftBinary : ComponentWithObjectFiles, ComponentWithDependencies

A binary built from Swift source and linked from the resulting object files.

Since
4.2

Functions

getCompileModules	`abstract fun getCompileModules(): FileCollection` Returns the modules to use to compile this binary. Includes the module file of this binary's dependencies.
getCompileTask	`abstract fun getCompileTask(): Provider<SwiftCompile>` Returns the compile task for this binary.
getLinkLibraries	`abstract fun getLinkLibraries(): FileCollection` Returns the link libraries to use to link this binary. Includes the link libraries of the component's dependencies.
getModule	`abstract fun getModule(): Provider<String>` Returns the name of the Swift module that this binary defines.
getModuleFile	`abstract fun getModuleFile(): Provider<RegularFile>` Returns the module file for this binary.
getRuntimeLibraries	`abstract fun getRuntimeLibraries(): FileCollection` Returns the runtime libraries required by this binary. Includes the runtime libraries of the component's dependencies.
getSourceCompatibility	`abstract fun getSourceCompatibility(): Provider<SwiftVersion>` Returns the Swift language level to use to compile the source files.
getSwiftSource	`abstract fun getSwiftSource(): FileCollection` Returns the Swift source files of this binary.
getTargetPlatform	`abstract fun getTargetPlatform(): SwiftPlatform` {@inheritDoc}
isTestable	`abstract fun isTestable(): Boolean` Returns true if this binary has testing enabled.

Inherited Functions

getDependencies	`abstract fun getDependencies(): ComponentDependencies` Returns the dependencies of this component.
getObjects	`abstract fun getObjects(): FileCollection` Returns the object files created for this component.

Inheritors

SwiftExecutable	`interface SwiftExecutable : SwiftBinary, ComponentWithExecutable, ComponentWithInstallation, ComponentWithOutputs` An executable built from Swift source.
SwiftSharedLibrary	`interface SwiftSharedLibrary : SwiftBinary, ComponentWithSharedLibrary, ComponentWithRuntimeUsage, ComponentWithLinkUsage, ComponentWithOutputs` A shared library built from Swift source.
SwiftStaticLibrary	`interface SwiftStaticLibrary : SwiftBinary, ComponentWithStaticLibrary, ComponentWithRuntimeUsage, ComponentWithLinkUsage, ComponentWithOutputs` A static library built from Swift source.
SwiftXCTestBinary	`interface SwiftXCTestBinary : SwiftBinary, TestComponent` An test binary built from Swift source.