fruity 0.3.0

Rusty bindings for Apple libraries
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

use super::OSErr;
use std::num::NonZeroI32;

/// A non-zero 32-bit error code.
///
/// This is the new counterpart to [`OSErr`](super::OSErr).
///
/// # Usage
///
/// In FFI code, this type is meant to be used as [`Option<OSStatus>`](Option).
/// [`None`] becomes 0 (no error) because this type is
/// [`#[repr(transparent)]`]((https://doc.rust-lang.org/nomicon/other-reprs.html#reprtransparent))
/// over [`NonZeroI32`].
///
/// Rust bindings that call `Option<OSStatus>`-returning functions should return
/// [`Result<T, OSStatus>`](Result).
#[repr(transparent)]
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub struct OSStatus(NonZeroI32);

impl From<OSErr> for OSStatus {
    #[inline]
    fn from(error: OSErr) -> Self {
        Self::from_os_err(error)
    }
}

impl From<NonZeroI32> for OSStatus {
    #[inline]
    fn from(value: NonZeroI32) -> Self {
        Self(value)
    }
}

impl OSStatus {
    /// Creates an instance from `value`, returning `None` if it is zero.
    #[inline]
    pub const fn new(value: i32) -> Option<Self> {
        match NonZeroI32::new(value) {
            Some(value) => Some(Self(value)),
            None => None,
        }
    }

    /// Creates an instance from a non-zero `value`.
    #[inline]
    pub const fn new_non_zero(value: NonZeroI32) -> Self {
        Self(value)
    }

    /// Creates an instance from `value`, without checking if it is zero.
    ///
    /// # Safety
    ///
    /// The value must not be zero.
    #[inline]
    pub const unsafe fn new_unchecked(value: i32) -> Self {
        Self(NonZeroI32::new_unchecked(value))
    }

    /// Converts an `OSErr` instance to an `OSStatus`.
    #[inline]
    pub const fn from_os_err(error: OSErr) -> Self {
        // SAFETY: `OSErr` can never have a zero value.
        unsafe { Self::new_unchecked(error.value() as i32) }
    }

    /// Returns this error's integer value.
    #[inline]
    pub const fn value(self) -> i32 {
        self.0.get()
    }

    /// Returns this error's non-zero integer value.
    #[inline]
    pub const fn non_zero_value(self) -> NonZeroI32 {
        self.0
    }
}