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

//! `UnixSocketConfiguration`, and its nested `UnixSocketConfiguration.Direction`.

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

/// `UnixSocketConfiguration.Direction`.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub enum Direction {
  #[default]
  Into,
  OutOf,
}

/// `UnixSocketConfiguration`.
///
/// It holds the Swift value, because Swift gives each configuration a private
/// `id` when it is made, and a relay is stopped by that `id`.
pub struct UnixSocketConfiguration {
  pub(crate) handle: ffi::CzUnixSocketConfiguration,
}

// Swift's `UnixSocketConfiguration` is `Sendable`, and the setters take
// `&mut self` because Swift's properties are `var`s of a struct.
unsafe impl Send for UnixSocketConfiguration {}
unsafe impl Sync for UnixSocketConfiguration {}

impl UnixSocketConfiguration {
  /// `UnixSocketConfiguration(source:destination:)`, with its other arguments
  /// at their defaults.
  pub fn new(source: impl AsRef<Path>, destination: impl AsRef<Path>) -> Result<Self, Error> {
    let source = platform::path(source.as_ref())?;
    let destination = platform::path(destination.as_ref())?;
    let outcome = platform::outcome(
      ffi::cz_unix_socket_configuration_new(source, destination),
      format!("configure a socket relay from {source} to {destination}"),
    )?;

    Ok(Self {
      handle: outcome.unix_socket_configuration(),
    })
  }

  /// `UnixSocketConfiguration.id`.
  pub fn id(&self) -> String {
    self.handle.id()
  }

  /// `UnixSocketConfiguration.source`.
  pub fn source(&self) -> PathBuf {
    PathBuf::from(self.handle.source())
  }

  /// Sets `UnixSocketConfiguration.source`. It fails if the path isn't UTF-8,
  /// which Swift's `String` requires.
  pub fn set_source(&mut self, source: impl AsRef<Path>) -> Result<(), Error> {
    self.handle.set_source(platform::path(source.as_ref())?);
    Ok(())
  }

  /// `UnixSocketConfiguration.destination`.
  pub fn destination(&self) -> PathBuf {
    PathBuf::from(self.handle.destination())
  }

  /// Sets `UnixSocketConfiguration.destination`. It fails if the path isn't
  /// UTF-8, which Swift's `String` requires.
  pub fn set_destination(&mut self, destination: impl AsRef<Path>) -> Result<(), Error> {
    self
      .handle
      .set_destination(platform::path(destination.as_ref())?);
    Ok(())
  }

  /// `UnixSocketConfiguration.permissions`, as the mode's raw value.
  pub fn permissions(&self) -> Option<u16> {
    self.handle.permissions()
  }

  /// Sets `UnixSocketConfiguration.permissions` to a mode's raw value.
  pub fn set_permissions(&mut self, permissions: Option<u16>) {
    self.handle.set_permissions(permissions);
  }

  /// `UnixSocketConfiguration.direction`.
  pub fn direction(&self) -> Direction {
    self.handle.direction().into()
  }

  /// Sets `UnixSocketConfiguration.direction`.
  pub fn set_direction(&mut self, direction: Direction) {
    self.handle.set_direction(direction.into());
  }
}

/// Swift's `UnixSocketConfiguration` is a struct, so a copy keeps its `id`.
impl Clone for UnixSocketConfiguration {
  fn clone(&self) -> Self {
    Self {
      handle: self.handle.duplicate(),
    }
  }
}

impl fmt::Debug for UnixSocketConfiguration {
  fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
    formatter
      .debug_struct("UnixSocketConfiguration")
      .field("id", &self.id())
      .field("source", &self.source())
      .field("destination", &self.destination())
      .field("permissions", &self.permissions())
      .field("direction", &self.direction())
      .finish()
  }
}

/// Two configurations are equal when the five fields Swift shows are equal,
/// including `id`, so only a configuration and its copies are equal. Swift's
/// type isn't `Equatable`.
impl PartialEq for UnixSocketConfiguration {
  fn eq(&self, other: &Self) -> bool {
    self.id() == other.id()
      && self.source() == other.source()
      && self.destination() == other.destination()
      && self.permissions() == other.permissions()
      && self.direction() == other.direction()
  }
}

impl Eq for UnixSocketConfiguration {}