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::container;
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;
use std::path::Path;

/// `InitImage`.
pub struct InitImage {
  pub(crate) handle: ffi::CzInitImage,
}

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

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

impl InitImage {
  /// `InitImage(image:)`.
  pub fn new(image: &Image) -> Self {
    Self {
      handle: image.handle.init_image(),
    }
  }

  /// `InitImage.create(reference:rootfs:platform:labels:imageStore:contentStore:)`.
  /// `rootfs` is a `.tar.gz` file.
  pub fn create(
    reference: &str,
    rootfs: &Path,
    platform: &containerization_oci::image::Platform,
    labels: &BTreeMap<String, String>,
    image_store: &ImageStore,
    content_store: &containerization_oci::content::LocalContentStore,
  ) -> Result<Self, Error> {
    platform::outcome(
      image_store.handle.create_init_image(
        reference,
        platform::path(rootfs)?,
        platform.clone(),
        labels.keys().cloned().collect(),
        labels.values().cloned().collect(),
        content_store.handle.duplicate(),
      ),
      format!("create init image {reference}"),
    )
    .map(|outcome| Self {
      handle: outcome.init_image(),
    })
  }

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

  /// `InitImage.initBlock(at:for:)`.
  pub fn init_block(&self, at: &Path, platform: vm::SystemPlatform) -> Result<container::Mount, Error> {
    platform::outcome(
      self.handle.init_block(platform::path(at)?, platform),
      format!("unpack {} to {}", self.name(), at.display()),
    )
    .map(|outcome| outcome.mount())
  }
}