containerization-framework 0.4.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
76
77
78
79
80
81
82
83
84
85

use super::Spec;
use crate::error::Error;
use crate::platform;
use crate::platform::ffi;
use std::path::Path;
use std::path::PathBuf;

/// `Bundle`, an OCI bundle on disk. Every method asks Swift.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct Bundle {
  path: PathBuf,
}

impl Bundle {
  /// `Bundle.create(path:spec:)`, which writes `spec` as `config.json`.
  pub fn create(path: &Path, spec: &Spec) -> Result<Self, Error> {
    Self::at(
      ffi::cz_bundle_create(&path.display().to_string(), spec.clone()),
      format!("create a bundle at {}", path.display()),
    )
  }

  /// `Bundle.create(path:spec:)` with `Data`, written unchecked.
  pub fn create_from_data(path: &Path, spec: &[u8]) -> Result<Self, Error> {
    Self::at(
      ffi::cz_bundle_create_from_data(&path.display().to_string(), spec.to_vec()),
      format!("create a bundle at {}", path.display()),
    )
  }

  /// `Bundle.load(path:)`, which fails if nothing is at `path`.
  pub fn load(path: &Path) -> Result<Self, Error> {
    Self::at(
      ffi::cz_bundle_load(&path.display().to_string()),
      format!("load the bundle at {}", path.display()),
    )
  }

  fn at(outcome: ffi::CzOutcome, action: String) -> Result<Self, Error> {
    platform::outcome(outcome, action).map(|outcome| Self {
      path: PathBuf::from(outcome.text()),
    })
  }

  /// `Bundle.path`.
  pub fn path(&self) -> &Path {
    &self.path
  }

  /// `Bundle.configPath`.
  pub fn config_path(&self) -> Result<PathBuf, Error> {
    platform::outcome(
      ffi::cz_bundle_config_path(&self.path.display().to_string()),
      "find a bundle's config",
    )
    .map(|outcome| PathBuf::from(outcome.text()))
  }

  /// `Bundle.rootfsPath`.
  pub fn rootfs_path(&self) -> Result<PathBuf, Error> {
    platform::outcome(
      ffi::cz_bundle_rootfs_path(&self.path.display().to_string()),
      "find a bundle's rootfs",
    )
    .map(|outcome| PathBuf::from(outcome.text()))
  }

  /// `Bundle.delete()`.
  pub fn delete(&self) -> Result<(), Error> {
    platform::outcome(
      ffi::cz_bundle_delete(&self.path.display().to_string()),
      format!("delete the bundle at {}", self.path.display()),
    )
    .map(drop)
  }

  /// `Bundle.loadConfig()`.
  pub fn load_config(&self) -> Result<Spec, Error> {
    platform::outcome(
      ffi::cz_bundle_load_config(&self.path.display().to_string()),
      format!("load the config of the bundle at {}", self.path.display()),
    )
    .map(|outcome| outcome.spec())
  }
}