Skip to content

STRUCT

Cache.Profile

Contents

  • Properties
    • name
    • configuration
    • platforms
    • scripts
    • options
    • description
  • Methods
    • init(name:configuration:platforms:scripts:options:)
    • profile(name:configuration:platforms:scripts:options:)
swift
public struct Profile: Codable, Hashable, CustomStringConvertible

A cache profile.

Properties

name

swift
public var name: String

The unique name of a profile

configuration

swift
public var configuration: String

The configuration to be used when building the project during a caching warmup

platforms

swift
public var platforms: [Platform: PlatformOptions]

The platforms this target support and target platform options

scripts

swift
public var scripts: [RunScript]

Scripts to run before warming up the cache

options

swift
public var options: Options

Additional options for cache profile

description

swift
public var description: String

Methods

init(name:configuration:platforms:scripts:options:)

swift
public init(
    name: String,
    configuration: String,
    platforms: [Platform: PlatformOptions],
    scripts: [RunScript] = [],
    options: Options = .options()
)

profile(name:configuration:platforms:scripts:options:)

swift
public static func profile(
    name: String,
    configuration: String,
    platforms: [Platform: PlatformOptions],
    scripts: [RunScript] = [],
    options: Options = .options()
) -> Profile

Returns a Cache.Profile instance.

  • Parameters:
    • name: The unique name of the cache profile
    • configuration: The configuration to be used when building the project during a caching warmup
    • platforms: Dictionary of platforms with platform options: e.g. arch, device, os
    • scripts: Scripts to run before warming up the cache
    • options: Additional options for cache profile
  • Returns: The Cache.Profile instance

Parameters

NameDescription
nameThe unique name of the cache profile
configurationThe configuration to be used when building the project during a caching warmup
platformsDictionary of platforms with platform options: e.g. arch, device, os
scriptsScripts to run before warming up the cache
optionsAdditional options for cache profile