containerization-framework 0.5.0

Rust bindings for Apple's Containerization framework: Linux containers in lightweight VMs, in-process and without a daemon.
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

use super::Image;
use super::ImageStore;
use crate::containerization::vm;
use crate::containerization_oci;
use crate::error::Error;
use crate::platform;
use crate::platform::ffi;
use std::collections::BTreeMap;
use std::fmt;

/// `KernelImage`.
pub struct KernelImage {
  handle: ffi::CzKernelImage,
}

impl fmt::Debug for KernelImage {
  fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
    formatter
      .debug_struct("KernelImage")
      .finish_non_exhaustive()
  }
}

// Swift's `KernelImage` is `Sendable`.
unsafe impl Send for KernelImage {}
unsafe impl Sync for KernelImage {}

impl KernelImage {
  /// `KernelImage.mediaType`.
  pub const MEDIA_TYPE: &str = "application/vnd.apple.containerization.kernel";

  /// `KernelImage(image:)`.
  pub fn new(image: &Image) -> Self {
    Self {
      handle: image.handle.kernel_image(),
    }
  }

  /// `KernelImage.name`.
  pub fn name(&self) -> String {
    self.handle.name()
  }

  /// `KernelImage.kernel(for:)`.
  pub fn kernel(&self, platform: vm::SystemPlatform) -> Result<vm::Kernel, Error> {
    platform::outcome(
      self.handle.kernel(platform),
      format!("find the kernel in {}", self.name()),
    )
    .map(|outcome| outcome.kernel())
  }

  /// `KernelImage.create(reference:binaries:labels:imageStore:contentStore:)`.
  pub fn create(
    reference: &str,
    binaries: &[vm::Kernel],
    labels: &BTreeMap<String, String>,
    image_store: &ImageStore,
    content_store: &containerization_oci::content::LocalContentStore,
  ) -> Result<Self, Error> {
    platform::outcome(
      image_store.handle.create_kernel_image(
        reference,
        binaries.to_vec(),
        labels.keys().cloned().collect(),
        labels.values().cloned().collect(),
        content_store.handle.duplicate(),
      ),
      format!("create kernel image {reference}"),
    )
    .map(|outcome| Self {
      handle: outcome.kernel_image(),
    })
  }
}