1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import _Concurrency
import struct Foundation.URL
/// The `Archiver` protocol abstracts away the different operations surrounding archives.
public protocol Archiver: Sendable {
/// A set of extensions the current archiver supports.
var supportedExtensions: Set<String> { get }
/// Asynchronously extracts the contents of an archive to a destination folder.
///
/// - Parameters:
/// - archivePath: The `AbsolutePath` to the archive to extract.
/// - destinationPath: The `AbsolutePath` to the directory to extract to.
/// - completion: The completion handler that will be called when the operation finishes to notify of its success.
@available(*, noasync, message: "Use the async alternative")
func extract(
from archivePath: AbsolutePath,
to destinationPath: AbsolutePath,
completion: @escaping @Sendable (Result<Void, Error>) -> Void
)
/// Asynchronously compress the contents of a directory to a destination archive.
///
/// - Parameters:
/// - directory: The `AbsolutePath` to the archive to extract.
/// - destinationPath: The `AbsolutePath` to the directory to extract to.
/// - completion: The completion handler that will be called when the operation finishes to notify of its success.
@available(*, noasync, message: "Use the async alternative")
func compress(
directory: AbsolutePath,
to destinationPath: AbsolutePath,
completion: @escaping @Sendable (Result<Void, Error>) -> Void
)
/// Asynchronously validates if a file is an archive.
///
/// - Parameters:
/// - path: The `AbsolutePath` to the archive to validate.
/// - completion: The completion handler that will be called when the operation finishes to notify of its success.
@available(*, noasync, message: "Use the async alternative")
func validate(
path: AbsolutePath,
completion: @escaping @Sendable (Result<Bool, Error>) -> Void
)
}
extension Archiver {
/// Asynchronously extracts the contents of an archive to a destination folder.
///
/// - Parameters:
/// - archivePath: The `AbsolutePath` to the archive to extract.
/// - destinationPath: The `AbsolutePath` to the directory to extract to.
public func extract(
from archivePath: AbsolutePath,
to destinationPath: AbsolutePath
) async throws {
try await withCheckedThrowingContinuation { continuation in
self.extract(from: archivePath, to: destinationPath, completion: { continuation.resume(with: $0) })
}
}
/// Asynchronously compresses the contents of a directory to a destination archive.
///
/// - Parameters:
/// - directory: The `AbsolutePath` to the archive to extract.
/// - destinationPath: The `AbsolutePath` to the directory to extract to.
public func compress(
directory: AbsolutePath,
to destinationPath: AbsolutePath
) async throws {
try await withCheckedThrowingContinuation { continuation in
self.compress(directory: directory, to: destinationPath, completion: { continuation.resume(with: $0) })
}
}
/// Asynchronously validates if a file is an archive.
///
/// - Parameters:
/// - path: The `AbsolutePath` to the archive to validate.
public func validate(
path: AbsolutePath
) async throws -> Bool {
try await withCheckedThrowingContinuation { continuation in
self.validate(path: path, completion: { continuation.resume(with: $0) })
}
}
package func isFileSupported(_ lastPathComponent: String) -> Bool {
self.supportedExtensions.contains(where: { lastPathComponent.hasSuffix($0) })
}
}
|
