CustomBinaryArtifactsManager

Types

• struct BinaryArtifactsManager
• class Configuration

  Manages a package workspace’s configuration.

• struct DefaultLocations

  Workspace default locations utilities

• struct DependencyManifests

  A struct representing all the current manifests (root + external) in a package graph.

• struct Location

  Workspace location configuration

• struct ManagedArtifact

  A downloaded artifact managed by the workspace.

• class ManagedArtifacts

  A collection of managed artifacts which have been downloaded.

• class ManagedDependencies

  A collection of managed dependencies.

• struct ManagedDependency

  An individual managed dependency.

• enum PackageStateChange

  This enum represents state of an external package.

• enum ResolutionPrecomputationResult
• enum SigningError

Typealiases

• typealias Delegate

Type members

• init(fileSystem: FileSystem?, environment: Environment, forRootPackage: AbsolutePath, authorizationProvider: AuthorizationProvider?, registryAuthorizationProvider: AuthorizationProvider?, configuration: WorkspaceConfiguration?, cancellator: Cancellator?, initializationWarningHandler: ((String) -> Void)?, customHostToolchain: UserToolchain?, customManifestLoader: ManifestLoaderProtocol?, customPackageContainerProvider: PackageContainerProvider?, customRepositoryProvider: RepositoryProvider?, delegate: Delegate?) throws

  A convenience method for creating a workspace for the given root package path.

• init(fileSystem: any FileSystem, environment: Environment, location: Location, authorizationProvider: (any AuthorizationProvider)?, registryAuthorizationProvider: (any AuthorizationProvider)?, configuration: WorkspaceConfiguration?, cancellator: Cancellator?, initializationWarningHandler: ((String) -> Void)?, customHostToolchain: UserToolchain?, customManifestLoader: (any ManifestLoaderProtocol)?, customPackageContainerProvider: (any PackageContainerProvider)?, customRepositoryProvider: (any RepositoryProvider)?, delegate: Delegate?) throws

  Create a new package workspace.

• init(fileSystem: FileSystem?, forRootPackage: AbsolutePath, authorizationProvider: AuthorizationProvider?, registryAuthorizationProvider: AuthorizationProvider?, configuration: WorkspaceConfiguration?, cancellator: Cancellator?, initializationWarningHandler: ((String) -> Void)?, customHostToolchain: UserToolchain, customPackageContainerProvider: PackageContainerProvider?, customRepositoryProvider: RepositoryProvider?, delegate: Delegate?) throws

  A convenience method for creating a workspace for the given root package path.

• static func format(workspaceResolveReason: WorkspaceResolveReason) -> String
• static func migrateMirrorsConfiguration(from: AbsolutePath, to: AbsolutePath, observabilityScope: ObservabilityScope) throws -> AbsolutePath

Instance members

• let fileSystem: any FileSystem

  The file system on which the workspace will operate.

• let location: Location

  The workspace location.

• let pinsStore: LoadableResult<PinsStore>

  The Pins store. The pins file will be created when first pin is added to pins store.

• let state: WorkspaceState

  The current persisted state of the workspace.

• func acceptIdentityChange(package: PackageIdentity, version: Version, signingEntity: SigningEntity, origin: SigningEntity.Origin, observabilityScope: ObservabilityScope, callbackQueue: DispatchQueue, completion: @escaping (Result<Void, Error>) -> Void)
• func cancelActiveResolverOperation()

  Cancel the active dependency resolution operation.

• func clean(observabilityScope: ObservabilityScope)

  Cleans the build artifacts from workspace data.

• func edit(packageName: String, path: AbsolutePath?, revision: Revision?, checkoutBranch: String?, observabilityScope: ObservabilityScope)

  Puts a dependency in edit mode creating a checkout in editables directory.

• func getContainer(for: PackageReference, updateStrategy: ContainerUpdateStrategy, observabilityScope: ObservabilityScope, on: DispatchQueue, completion: @escaping (Result<any PackageContainer, any Swift.Error>) -> Void)
• func interpreterFlags(for: AbsolutePath) -> [String]

  Returns manifest interpreter flags for a package.

• func loadDependencyManifests(root: PackageGraphRoot, automaticallyAddManagedDependencies: Bool, observabilityScope: ObservabilityScope) throws -> DependencyManifests

  Load the manifests for the current dependency tree.

• func loadPackage(with: PackageIdentity, packageGraph: ModulesGraph, observabilityScope: ObservabilityScope) async throws -> Package
• func loadPackage(with: PackageIdentity, packageGraph: ModulesGraph, observabilityScope: ObservabilityScope, completion: @escaping (Result<Package, Error>) -> Void)

  Loads a single package in the context of a previously loaded graph. This can be useful for incremental loading in a longer-lived program, like an IDE.

• func loadPackageGraph(rootInput: PackageGraphRootInput, explicitProduct: String?, forceResolvedVersions: Bool, customXCTestMinimumDeploymentTargets: [PackageModel.Platform : PlatformVersion]?, testEntryPointPath: AbsolutePath?, expectedSigningEntities: [PackageIdentity : RegistryReleaseMetadata.SigningEntity], observabilityScope: ObservabilityScope) throws -> ModulesGraph
• func loadPackageGraph(rootPath: AbsolutePath, explicitProduct: String?, observabilityScope: ObservabilityScope) throws -> ModulesGraph
• func loadPluginImports(packageGraph: ModulesGraph) async throws -> [PackageIdentity : [String : [String]]]
• func loadRootManifest(at: AbsolutePath, observabilityScope: ObservabilityScope) async throws -> Manifest

  Loads and returns manifest at the given path.

• func loadRootManifest(at: AbsolutePath, observabilityScope: ObservabilityScope, completion: @escaping (Result<Manifest, Error>) -> Void)

  Loads and returns manifest at the given path.

• func loadRootManifests(packages: [AbsolutePath], observabilityScope: ObservabilityScope) async throws -> [AbsolutePath : Manifest]

  Loads and returns manifests at the given paths.

• func loadRootManifests(packages: [AbsolutePath], observabilityScope: ObservabilityScope, completion: @escaping (Result<[AbsolutePath : Manifest], Error>) -> Void)

  Loads and returns manifests at the given paths.

• func loadRootPackage(at: AbsolutePath, observabilityScope: ObservabilityScope) async throws -> Package

  Loads root package

• func loadRootPackage(at: AbsolutePath, observabilityScope: ObservabilityScope, completion: @escaping (Result<Package, Error>) -> Void)

  Loads root package

• func path(to: Workspace.ManagedDependency) -> AbsolutePath

  Returns the location of the dependency.

• func precomputeResolution(root: PackageGraphRoot, dependencyManifests: DependencyManifests, pinsStore: PinsStore, constraints: [PackageContainerConstraint], observabilityScope: ObservabilityScope) throws -> ResolutionPrecomputationResult

  Computes if dependency resolution is required based on input constraints and pins.

• func purgeCache(observabilityScope: ObservabilityScope)

  Cleans the build artifacts from workspace data.

• func reset(observabilityScope: ObservabilityScope)

  Resets the entire workspace by removing the data directory.

• func resetState() throws
• func resolve(packageName: String, root: PackageGraphRootInput, version: Version?, branch: String?, revision: String?, observabilityScope: ObservabilityScope) throws

  Resolve a package at the given state.

• func resolve(root: PackageGraphRootInput, explicitProduct: String?, forceResolution: Bool, forceResolvedVersions: Bool, observabilityScope: ObservabilityScope) throws

  Perform dependency resolution if needed.

• func resolveBasedOnResolvedVersionsFile(root: PackageGraphRootInput, observabilityScope: ObservabilityScope) throws

  Resolves the dependencies according to the entries present in the Package.resolved file.

• func unedit(packageName: String, forceRemove: Bool, root: PackageGraphRootInput, observabilityScope: ObservabilityScope) throws

  Ends the edit mode of an edited dependency.

• func updateDependencies(root: PackageGraphRootInput, packages: [String], dryRun: Bool, observabilityScope: ObservabilityScope) throws -> [(PackageReference, Workspace.PackageStateChange)]?

  Updates the current dependencies.

• func watchResolvedFile() throws

  Watch the Package.resolved for changes.