mirror of
https://github.com/apple/container.git
synced 2026-09-08 08:45:43 +00:00
Danny Canter
6bc4bf5124
This change adds documentation to quite a few existing public types that didn't have a blurb before. Additionally, this fixes a couple things that I think either didn't make sense when going to document them: - Rename ConnectionStream to VsockConnectionStream. This type only functions for vsock connections. - Deletes NsLock+Closure. This was not used anywhere. - Rename ContainerizationOCI/Config.swift to ImageConfig.swift. Signed-off-by: Danny Canter <danny_canter@apple.com>
47 lines
1.7 KiB
Swift
47 lines
1.7 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025 Apple Inc. and the containerization project authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import Foundation
|
|
|
|
/// `Timeout` contains helpers to run an operation and error out if
|
|
/// the operation does not finish within a provided time.
|
|
public struct Timeout {
|
|
/// Performs the passed in `operation` and throws a `CancellationError` if the operation
|
|
/// doesn't finish in the provided `seconds` amount.
|
|
public static func run<T: Sendable>(
|
|
seconds: UInt32,
|
|
operation: @escaping @Sendable () async -> T
|
|
) async throws -> T {
|
|
try await withThrowingTaskGroup(of: T.self) { group in
|
|
group.addTask {
|
|
await operation()
|
|
}
|
|
|
|
group.addTask {
|
|
try await Task.sleep(for: .seconds(seconds))
|
|
throw CancellationError()
|
|
}
|
|
|
|
guard let result = try await group.next() else {
|
|
fatalError()
|
|
}
|
|
|
|
group.cancelAll()
|
|
return result
|
|
}
|
|
}
|
|
}
|