objc2_virtualization/generated/
VZLinuxRosettaDirectoryShare.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10/// Availability of Rosetta support for Linux binaries.
11///
12/// See also [Apple's documentation](https://developer.apple.com/documentation/virtualization/vzlinuxrosettaavailability?language=objc)
13// NS_ENUM
14#[repr(transparent)]
15#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
16pub struct VZLinuxRosettaAvailability(pub NSInteger);
17impl VZLinuxRosettaAvailability {
18    /// Rosetta support for Linux binaries is not available on the host system.
19    #[doc(alias = "VZLinuxRosettaAvailabilityNotSupported")]
20    pub const NotSupported: Self = Self(0);
21    /// Rosetta support for Linux binaries is not installed on the host system.
22    #[doc(alias = "VZLinuxRosettaAvailabilityNotInstalled")]
23    pub const NotInstalled: Self = Self(1);
24    /// Rosetta support for Linux is installed on the host system.
25    #[doc(alias = "VZLinuxRosettaAvailabilityInstalled")]
26    pub const Installed: Self = Self(2);
27}
28
29unsafe impl Encode for VZLinuxRosettaAvailability {
30    const ENCODING: Encoding = NSInteger::ENCODING;
31}
32
33unsafe impl RefEncode for VZLinuxRosettaAvailability {
34    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
35}
36
37extern_class!(
38    /// Directory share to enable Rosetta support for Linux binaries.
39    ///
40    /// This directory share exposes Rosetta within a shared directory in the guest. Linux can use it to translate x86_64 binaries.
41    ///
42    /// See: VZDirectorySharingDeviceConfiguration
43    ///
44    /// See: VZSharedDirectory
45    ///
46    /// See also [Apple's documentation](https://developer.apple.com/documentation/virtualization/vzlinuxrosettadirectoryshare?language=objc)
47    #[unsafe(super(VZDirectoryShare, NSObject))]
48    #[derive(Debug, PartialEq, Eq, Hash)]
49    #[cfg(feature = "VZDirectoryShare")]
50    pub struct VZLinuxRosettaDirectoryShare;
51);
52
53#[cfg(feature = "VZDirectoryShare")]
54extern_conformance!(
55    unsafe impl NSObjectProtocol for VZLinuxRosettaDirectoryShare {}
56);
57
58#[cfg(feature = "VZDirectoryShare")]
59impl VZLinuxRosettaDirectoryShare {
60    extern_methods!(
61        /// Initialize a Rosetta directory share if Rosetta support for Linux binaries is installed.
62        ///
63        /// Parameter `error`: Error object to store the error, if an error exists.
64        ///
65        /// The call returns an error if Rosetta is not available for a directory share. To install Rosetta support, use +[VZLinuxRosettaDirectoryShare installRosettaIfNeeded:].
66        ///
67        /// See: +[VZLinuxRosettaDirectoryShare installRosettaIfNeeded:]
68        #[unsafe(method(initWithError:_))]
69        #[unsafe(method_family = init)]
70        pub unsafe fn initWithError(
71            this: Allocated<Self>,
72        ) -> Result<Retained<Self>, Retained<NSError>>;
73
74        #[cfg(feature = "block2")]
75        /// Download and install Rosetta support for Linux binaries if necessary.
76        ///
77        /// Parameter `completionHandler`: The completion handler gets called with a valid error on failure and a nil error on success. It will also be invoked on an arbitrary queue.
78        ///
79        /// The call prompts the user through the download and install flow for Rosetta. This call is successful if the error is nil.
80        ///
81        /// See: +[VZLinuxRosettaDirectoryShare availability]
82        #[unsafe(method(installRosettaWithCompletionHandler:))]
83        #[unsafe(method_family = none)]
84        pub unsafe fn installRosettaWithCompletionHandler(
85            completion_handler: &block2::DynBlock<dyn Fn(*mut NSError)>,
86        );
87
88        #[cfg(feature = "VZLinuxRosettaCachingOptions")]
89        /// Enable translation caching and configure the socket communication type for Rosetta.
90        #[unsafe(method(options))]
91        #[unsafe(method_family = none)]
92        pub unsafe fn options(&self) -> Option<Retained<VZLinuxRosettaCachingOptions>>;
93
94        #[cfg(feature = "VZLinuxRosettaCachingOptions")]
95        /// Setter for [`options`][Self::options].
96        #[unsafe(method(setOptions:))]
97        #[unsafe(method_family = none)]
98        pub unsafe fn setOptions(&self, options: Option<&VZLinuxRosettaCachingOptions>);
99
100        /// Check the availability of Rosetta support for the directory share.
101        #[unsafe(method(availability))]
102        #[unsafe(method_family = none)]
103        pub unsafe fn availability() -> VZLinuxRosettaAvailability;
104    );
105}
106
107/// Methods declared on superclass `VZDirectoryShare`.
108#[cfg(feature = "VZDirectoryShare")]
109impl VZLinuxRosettaDirectoryShare {
110    extern_methods!(
111        #[unsafe(method(new))]
112        #[unsafe(method_family = new)]
113        pub unsafe fn new() -> Retained<Self>;
114
115        #[unsafe(method(init))]
116        #[unsafe(method_family = init)]
117        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
118    );
119}