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
86
87
88
89
90

//! `SystemPlatform`, and its nested `SystemPlatform.OS` and
//! `SystemPlatform.Architecture`.

use crate::containerization_oci;
use crate::error::Error;
use crate::platform;
use crate::platform::ffi;

macro_rules! raw_values {
  ($(#[$doc:meta])* $name:ident { $($case:ident = $raw_value:literal),* $(,)? }) => {
    $(#[$doc])*
    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
    pub enum $name {
      $($case),*
    }

    impl $name {
      /// `allCases`.
      pub const ALL_CASES: &[Self] = &[$(Self::$case),*];

      /// `init(rawValue:)`, which is `None` for a raw value Swift lacks.
      pub fn from_raw_value(raw_value: &str) -> Option<Self> {
        Self::ALL_CASES.iter().copied().find(|case| case.as_str() == raw_value)
      }

      /// `rawValue`.
      pub fn as_str(self) -> &'static str {
        match self {
          $(Self::$case => $raw_value),*
        }
      }
    }
  };
}

raw_values!(
  /// `SystemPlatform.OS`.
  Os { Linux = "linux", Darwin = "darwin" }
);

raw_values!(
  /// `SystemPlatform.Architecture`.
  Architecture { Arm64 = "arm64", Amd64 = "amd64" }
);

/// `SystemPlatform`.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SystemPlatform {
  pub os: Os,
  pub architecture: Architecture,
}

impl SystemPlatform {
  /// `SystemPlatform.linuxArm`.
  pub const LINUX_ARM: Self = Self {
    os: Os::Linux,
    architecture: Architecture::Arm64,
  };

  /// `SystemPlatform.linuxAmd`.
  pub const LINUX_AMD: Self = Self {
    os: Os::Linux,
    architecture: Architecture::Amd64,
  };

  /// `SystemPlatform.ociPlatform()`.
  pub fn oci_platform(&self) -> Result<containerization_oci::image::Platform, Error> {
    platform::outcome(
      ffi::cz_system_platform_oci_platform(*self),
      "convert a system platform to OCI's",
    )
    .map(|outcome| outcome.platform())
  }
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn reads_back_every_raw_value_it_writes() {
    for os in Os::ALL_CASES {
      assert_eq!(Os::from_raw_value(os.as_str()), Some(*os));
    }
    for architecture in Architecture::ALL_CASES {
      assert_eq!(Architecture::from_raw_value(architecture.as_str()), Some(*architecture));
    }
    assert_eq!(Os::from_raw_value("Linux"), None, "raw values are case sensitive");
  }
}