mirror of
https://github.com/apple/container.git
synced 2026-09-08 00:35: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>
42 lines
1.6 KiB
Swift
42 lines
1.6 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 ContainerizationOCI
|
|
|
|
/// `SystemPlatform` describes an operating system and architecture pair.
|
|
/// This is primarily used to choose what kind of OCI image to pull from a
|
|
/// registry.
|
|
public struct SystemPlatform: Sendable, Codable {
|
|
public enum OS: String, CaseIterable, Sendable, Codable {
|
|
case linux
|
|
case darwin
|
|
}
|
|
public let os: OS
|
|
|
|
public enum Architecture: String, CaseIterable, Sendable, Codable {
|
|
case arm64
|
|
case amd64
|
|
}
|
|
public let architecture: Architecture
|
|
|
|
public func ociPlatform() -> ContainerizationOCI.Platform {
|
|
ContainerizationOCI.Platform(arch: architecture.rawValue, os: os.rawValue)
|
|
}
|
|
|
|
public static var linuxArm: SystemPlatform { .init(os: .linux, architecture: .arm64) }
|
|
public static var linuxAmd: SystemPlatform { .init(os: .linux, architecture: .amd64) }
|
|
}
|