ManagedArtifacts
A collection of managed artifacts which have been downloaded.
ManagedArtifact.swift:119final class ManagedArtifactsOther members in extension
View members
Hide members
This section is hidden by default because it contains too many (52) members.
Types
struct BinaryArtifactsManagerclass ConfigurationManages a package workspace’s configuration.
struct CustomBinaryArtifactsManagerstruct DefaultLocationsWorkspace default locations utilities
struct DependencyManifestsA struct representing all the current manifests (root + external) in a package graph.
struct LocationWorkspace location configuration
struct ManagedArtifactA downloaded artifact managed by the workspace.
class ManagedDependenciesA collection of managed dependencies.
struct ManagedDependencyAn individual managed dependency.
enum PackageStateChangeThis enum represents state of an external package.
enum ResolutionPrecomputationResultenum SigningError
Typealiases
Type members
static func format(workspaceResolveReason: WorkspaceResolveReason) -> String static func migrateMirrorsConfiguration(from: AbsolutePath, to: AbsolutePath, observabilityScope: ObservabilityScope) throws -> AbsolutePath
Show implementation details (1)
Hide implementation details
Instance members
let fileSystem: any FileSystemThe file system on which the workspace will operate.
let location: LocationThe 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: WorkspaceStateThe 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.
Citizens in Workspace
Conformances
protocol Collection<Element>A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol Escapableprotocol Sequence<Element>A type that provides sequential, iterated access to its elements.
Instance members
var description: Stringvar endIndex: AnyIndexvar startIndex: AnyIndexsubscript(AnyIndex) -> Workspace.ManagedArtifact subscript(packageIdentity: PackageIdentity, targetName: String) -> ManagedArtifact? func add(ManagedArtifact) func index(after: AnyIndex) -> AnyIndex func remove(packageIdentity: PackageIdentity, targetName: String)
Instance features
var count: IntThe number of elements in the collection.
var first: Self.Element?The first element of the collection.
var indices: DefaultIndices<Self>The indices that are valid for subscripting the collection, in ascending order.
var isEmpty: BoolA Boolean value indicating whether the collection is empty.
var lazy: LazySequence<Self>A sequence containing the same elements as this sequence, but on which some operations, such as
mapandfilter, are implemented lazily.var underestimatedCount: IntA value less than or equal to the number of elements in the collection.
func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-
nilresults of calling the given transformation with each element of this sequence.func compare<Comparator>(Comparator.Compared, Comparator.Compared) -> ComparisonResult If
lhsis ordered beforerhsin the ordering described by the given sequence ofSortComparatorsfunc contains(where: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func count<E>(where: (Self.Element)throws Returns the number of elements in the sequence that satisfy the given predicate.
func distance(from: Self.Index, to: Self.Index) -> Int Returns the distance between two indices.
func drop(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while
predicatereturnstrueand returning the remaining elements.func dropFirst(Int) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequence Returns a subsequence containing all but the specified number of final elements.
func elementsEqual<OtherSequence>(OtherSequence, by: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.
func enumerated() -> EnumeratedSequence<Self> Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.
func filter((Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func filter(Predicate<Self.Element>) throws -> [Self.Element] func first(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func flatMap<SegmentOfResult>((Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach((Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a
for-inloop.func formIndex(inout Self.Index, offsetBy: Int) Offsets the given index by the specified distance.
func formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex(after: inout Self.Index) Replaces the given index with its successor.
func formatted<S>(S) -> S.FormatOutput func index(Self.Index, offsetBy: Int) -> Self.Index Returns an index that is the specified distance from the given index.
func index(Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Self.Index? Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func indices(where: (Self.Element) throws -> Bool) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func makeIterator() -> IndexingIterator<Self> Returns an iterator over the elements of the collection.
func map<T, E>((Self.Element)throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>((Self.Element)throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func prefix(Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until
predicatereturnsfalseand skipping the remaining elements.func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using: inout T) -> Self.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, Self.Element) throws -> Result) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func removingSubranges(RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
func reversed() -> [Self.Element] Returns an array containing the elements of this sequence in reverse order.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [Self.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func sorted<Comparator>(using: Comparator) -> [Self.Element] Returns the elements of the sequence, sorted using the given comparator to compare elements.
func sorted<S, Comparator>(using: S) -> [Self.Element] Returns the elements of the sequence, sorted using the given array of
SortComparators to compare elements.func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Self.Element) throws -> Bool) rethrows -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func starts<PossiblePrefix>(with: PossiblePrefix, by: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.
func suffix(Int) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
func trimmingPrefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R?