mirror of
https://github.com/apple/container.git
synced 2026-09-12 10:45:42 +00:00
Aditya Ramani
bdba5b5740
Creates a new Unpacker protocol that defines a single method ``` func unpack(_ image: Image, for platform: Platform, at path: URL, progress: ProgressHandler?) async throws -> Mount ``` This change also removes the `unpack(...)` method from the Image type. Before ``` let mount = try await image.unpack(for: platform, at: path) ``` After ``` let unpacker = EXT4Unpacker(blockSizeInBytes: 2.gib()) let mount = try await unpacker.unpack(image, for: platform, at: path) ``` --------- Signed-off-by: Aditya Ramani <a_ramani@apple.com>
41 lines
1.9 KiB
Swift
41 lines
1.9 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 ContainerizationExtras
|
|
import ContainerizationOCI
|
|
import Foundation
|
|
|
|
/// The `Unpacker` protocol defines a standardized interface that involves
|
|
/// decompressing, extracting image layers and preparing it for use.
|
|
///
|
|
/// The `Unpacker` is responsible for managing the lifecycle of the
|
|
/// unpacking process, including any temporary files or resources, until the
|
|
/// `Mount` object is produced.
|
|
public protocol Unpacker {
|
|
|
|
/// Unpacks the provided image to a specified path for a given platform.
|
|
///
|
|
/// This asynchronous method should handle the entire unpacking process, from reading
|
|
/// the `Image` layers for the given `Platform` via its `Manifest`,
|
|
/// to making the extracted contents available as a `Mount`.
|
|
/// Implementations of this method may apply platform-specific optimizations
|
|
/// or transformations during the unpacking.
|
|
///
|
|
/// Progress updates can be observed via the optional `progress` handler.
|
|
func unpack(_ image: Image, for platform: Platform, at path: URL, progress: ProgressHandler?) async throws -> Mount
|
|
|
|
}
|