objc2-disk-arbitration 0.3.2

Bindings to the DiskArbitration framework
Documentation 
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

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::cell::UnsafeCell;
use core::ffi::*;
use core::marker::{PhantomData, PhantomPinned};
use core::ptr::NonNull;
#[cfg(feature = "objc2")]
use objc2::__framework_prelude::*;
use objc2_core_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnsuccess?language=objc)
pub const kDAReturnSuccess: c_int = 0;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnerror?language=objc)
pub const kDAReturnError: c_int = -119930879;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnbusy?language=objc)
pub const kDAReturnBusy: c_int = -119930878;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnbadargument?language=objc)
pub const kDAReturnBadArgument: c_int = -119930877;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnexclusiveaccess?language=objc)
pub const kDAReturnExclusiveAccess: c_int = -119930876;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnoresources?language=objc)
pub const kDAReturnNoResources: c_int = -119930875;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotfound?language=objc)
pub const kDAReturnNotFound: c_int = -119930874;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotmounted?language=objc)
pub const kDAReturnNotMounted: c_int = -119930873;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotpermitted?language=objc)
pub const kDAReturnNotPermitted: c_int = -119930872;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotprivileged?language=objc)
pub const kDAReturnNotPrivileged: c_int = -119930871;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotready?language=objc)
pub const kDAReturnNotReady: c_int = -119930870;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnnotwritable?language=objc)
pub const kDAReturnNotWritable: c_int = -119930869;
/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/kdareturnunsupported?language=objc)
pub const kDAReturnUnsupported: c_int = -119930868;

/// [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/dareturn?language=objc)
#[cfg(feature = "libc")]
pub type DAReturn = libc::mach_error_t;

/// Type of a reference to DADissenter instances.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/diskarbitration/dadissenter?language=objc)
#[doc(alias = "DADissenterRef")]
#[repr(C)]
pub struct DADissenter {
    inner: [u8; 0],
    _p: UnsafeCell<PhantomData<(*const UnsafeCell<()>, PhantomPinned)>>,
}

cf_type!(
    unsafe impl DADissenter {}
);
#[cfg(feature = "objc2")]
cf_objc2_type!(
    unsafe impl RefEncode<"__DADissenter"> for DADissenter {}
);

impl DADissenter {
    /// Creates a new dissenter object.
    ///
    /// Parameter `allocator`: The allocator object to be used to allocate memory.
    ///
    /// Parameter `status`: The return code.
    ///
    /// Parameter `string`: The return code string.  Pass NULL for no reason.
    ///
    /// Returns: A reference to a new DADissenter.
    #[doc(alias = "DADissenterCreate")]
    #[cfg(feature = "libc")]
    #[inline]
    pub unsafe fn new(
        allocator: Option<&CFAllocator>,
        status: DAReturn,
        string: Option<&CFString>,
    ) -> CFRetained<DADissenter> {
        extern "C-unwind" {
            fn DADissenterCreate(
                allocator: Option<&CFAllocator>,
                status: DAReturn,
                string: Option<&CFString>,
            ) -> Option<NonNull<DADissenter>>;
        }
        let ret = unsafe { DADissenterCreate(allocator, status, string) };
        let ret =
            ret.expect("function was marked as returning non-null, but actually returned NULL");
        unsafe { CFRetained::from_raw(ret) }
    }

    /// Obtains the return code.
    ///
    /// Parameter `dissenter`: The DADissenter for which to obtain the return code.
    ///
    /// Returns: The return code.  A BSD return code, if applicable, is encoded with unix_err().
    #[doc(alias = "DADissenterGetStatus")]
    #[cfg(feature = "libc")]
    #[inline]
    pub unsafe fn status(&self) -> DAReturn {
        extern "C-unwind" {
            fn DADissenterGetStatus(dissenter: &DADissenter) -> DAReturn;
        }
        unsafe { DADissenterGetStatus(self) }
    }

    /// Obtains the return code string.
    ///
    /// Parameter `dissenter`: The DADissenter for which to obtain the return code string.
    ///
    /// Returns: The return code string.
    #[doc(alias = "DADissenterGetStatusString")]
    #[inline]
    pub unsafe fn status_string(&self) -> Option<CFRetained<CFString>> {
        extern "C-unwind" {
            fn DADissenterGetStatusString(dissenter: &DADissenter) -> Option<NonNull<CFString>>;
        }
        let ret = unsafe { DADissenterGetStatusString(self) };
        ret.map(|ret| unsafe { CFRetained::retain(ret) })
    }
}

#[cfg(feature = "libc")]
#[deprecated = "renamed to `DADissenter::new`"]
#[inline]
pub unsafe extern "C-unwind" fn DADissenterCreate(
    allocator: Option<&CFAllocator>,
    status: DAReturn,
    string: Option<&CFString>,
) -> CFRetained<DADissenter> {
    extern "C-unwind" {
        fn DADissenterCreate(
            allocator: Option<&CFAllocator>,
            status: DAReturn,
            string: Option<&CFString>,
        ) -> Option<NonNull<DADissenter>>;
    }
    let ret = unsafe { DADissenterCreate(allocator, status, string) };
    let ret = ret.expect("function was marked as returning non-null, but actually returned NULL");
    unsafe { CFRetained::from_raw(ret) }
}

extern "C-unwind" {
    #[cfg(feature = "libc")]
    #[deprecated = "renamed to `DADissenter::status`"]
    pub fn DADissenterGetStatus(dissenter: &DADissenter) -> DAReturn;
}

#[deprecated = "renamed to `DADissenter::status_string`"]
#[inline]
pub unsafe extern "C-unwind" fn DADissenterGetStatusString(
    dissenter: &DADissenter,
) -> Option<CFRetained<CFString>> {
    extern "C-unwind" {
        fn DADissenterGetStatusString(dissenter: &DADissenter) -> Option<NonNull<CFString>>;
    }
    let ret = unsafe { DADissenterGetStatusString(dissenter) };
    ret.map(|ret| unsafe { CFRetained::retain(ret) })
}