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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

//! Images, the store they are kept in, and unpacking them into a root
//! filesystem. `Image` is here, with its nested `Image.Description`.

mod ext4_unpacker;
pub mod image_store;
mod init_image;
mod kernel_image;

pub use self::ext4_unpacker::EXT4Unpacker;
pub use self::image_store::ImageStore;
pub use self::init_image::InitImage;
pub use self::kernel_image::KernelImage;

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

/// `Image.Description`.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Description {
  pub reference: String,
  pub descriptor: containerization_oci::image::Descriptor,
}

impl Description {
  /// `Image.Description(reference:descriptor:)`.
  pub fn new(reference: impl Into<String>, descriptor: containerization_oci::image::Descriptor) -> Self {
    Self {
      reference: reference.into(),
      descriptor,
    }
  }

  /// `Image.Description.digest`: the descriptor's.
  pub fn digest(&self) -> &str {
    &self.descriptor.digest
  }

  /// `Image.Description.mediaType`: the descriptor's.
  pub fn media_type(&self) -> &str {
    &self.descriptor.media_type
  }
}

/// A platform in an error's action, without asking Swift for its description.
fn named(platform: &containerization_oci::image::Platform) -> String {
  format!("{}/{}", platform.os, platform.architecture)
}

/// `Image`.
pub struct Image {
  pub(crate) handle: ffi::CzImage,
}

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

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

impl Image {
  /// `Image(description:contentStore:)`.
  pub fn new(description: &Description, content_store: &containerization_oci::content::LocalContentStore) -> Self {
    Self {
      handle: content_store.handle.image(description.clone()),
    }
  }

  /// `Image.reference`.
  pub fn reference(&self) -> String {
    self.handle.reference()
  }

  /// `Image.digest`.
  pub fn digest(&self) -> String {
    self.handle.digest()
  }

  /// `Image.mediaType`.
  pub fn media_type(&self) -> String {
    self.handle.media_type()
  }

  /// `Image.description`.
  pub fn description(&self) -> Description {
    Description::new(self.reference(), self.descriptor())
  }

  /// `Image.descriptor`.
  pub fn descriptor(&self) -> containerization_oci::image::Descriptor {
    self.handle.descriptor().descriptor()
  }

  /// `Image.index()`.
  pub fn index(&self) -> Result<containerization_oci::image::Index, Error> {
    platform::outcome(self.handle.index(), format!("read the index of {}", self.reference()))
      .map(|outcome| outcome.index())
  }

  /// `Image.manifest(for:)`.
  pub fn manifest(
    &self,
    for_platform: &containerization_oci::image::Platform,
  ) -> Result<containerization_oci::image::Manifest, Error> {
    platform::outcome(
      self.handle.manifest(for_platform.clone()),
      format!("read the manifest of {} for {}", self.reference(), named(for_platform)),
    )
    .map(|outcome| outcome.manifest())
  }

  /// `Image.descriptor(for:)`. Rust has no overloading, so the suffix names
  /// the argument label that tells it apart from [`Self::descriptor`].
  pub fn descriptor_for(
    &self,
    for_platform: &containerization_oci::image::Platform,
  ) -> Result<containerization_oci::image::Descriptor, Error> {
    platform::outcome(
      self.handle.descriptor_for(for_platform.clone()),
      format!("find the manifest of {} for {}", self.reference(), named(for_platform)),
    )
    .map(|outcome| outcome.descriptor())
  }

  /// `Image.config(for:)`.
  pub fn config(
    &self,
    for_platform: &containerization_oci::image::Platform,
  ) -> Result<containerization_oci::image::Image, Error> {
    platform::outcome(
      self.handle.config(for_platform.clone()),
      format!("read the config of {} for {}", self.reference(), named(for_platform)),
    )
    .map(|outcome| outcome.oci_image())
  }

  /// `Image.referencedDigests()`.
  pub fn referenced_digests(&self) -> Result<Vec<String>, Error> {
    platform::outcome(
      self.handle.referenced_digests(),
      format!("list what {} is made of", self.reference()),
    )
    .map(|outcome| outcome.strings())
  }

  /// `Image.getContent(digest:)`.
  pub fn get_content(&self, digest: &str) -> Result<containerization_oci::content::Content, Error> {
    platform::outcome(
      self.handle.get_content(digest),
      format!("get {digest} from {}", self.reference()),
    )
    .map(|outcome| containerization_oci::content::Content {
      handle: outcome.content(),
    })
  }
}