magnus 0.8.2

High level Ruby bindings. Write Ruby extension gems in Rust, or call Ruby code from a Rust binary.
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

use std::fmt;
#[cfg(ruby_lt_3_3)]
use std::ptr::NonNull;

#[cfg(ruby_gte_3_3)]
use rb_sys::rb_io_descriptor;
use rb_sys::ruby_value_type;

use crate::{
    error::Error,
    into_value::IntoValue,
    object::Object,
    try_convert::TryConvert,
    value::{
        private::{self, ReprValue as _},
        NonZeroValue, ReprValue, Value,
    },
    Ruby,
};

/// A Value pointer to a RFile struct, Ruby's internal representation of IO.
///
/// See the [`ReprValue`] and [`Object`] traits for additional methods
/// available on this type.
#[derive(Clone, Copy)]
#[repr(transparent)]
pub struct RFile(NonZeroValue);

impl RFile {
    /// Return `Some(RFile)` if `val` is a `RFile`, `None` otherwise.
    ///
    /// # Examples
    ///
    /// ```
    /// use magnus::{eval, RFile};
    /// # let ruby = unsafe { magnus::embed::init() };
    ///
    /// assert!(RFile::from_value(eval("STDOUT").unwrap()).is_some());
    /// # #[cfg(not(windows))]
    /// # {
    /// assert!(RFile::from_value(eval(r#"File.open("/tmp/example.txt", "w+")"#).unwrap()).is_some());
    /// # ruby.require("socket").unwrap();
    /// assert!(RFile::from_value(eval("UNIXSocket.pair.first").unwrap()).is_some());
    /// # }
    /// assert!(RFile::from_value(eval("nil").unwrap()).is_none());
    /// ```
    #[inline]
    pub fn from_value(val: Value) -> Option<Self> {
        unsafe {
            (val.rb_type() == ruby_value_type::RUBY_T_FILE)
                .then(|| Self(NonZeroValue::new_unchecked(val)))
        }
    }

    #[cfg(ruby_lt_3_3)]
    fn as_internal(self) -> NonNull<rb_sys::RFile> {
        // safe as inner value is NonZero
        unsafe { NonNull::new_unchecked(self.0.get().as_rb_value() as *mut _) }
    }
}

impl fmt::Display for RFile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", unsafe { self.to_s_infallible() })
    }
}

impl fmt::Debug for RFile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.inspect())
    }
}

impl IntoValue for RFile {
    #[inline]
    fn into_value_with(self, _: &Ruby) -> Value {
        self.0.get()
    }
}

impl Object for RFile {}

unsafe impl private::ReprValue for RFile {}

impl ReprValue for RFile {}

impl TryConvert for RFile {
    fn try_convert(val: Value) -> Result<Self, Error> {
        Self::from_value(val).ok_or_else(|| {
            Error::new(
                Ruby::get_with(val).exception_type_error(),
                format!("no implicit conversion of {} into File", unsafe {
                    val.classname()
                },),
            )
        })
    }
}

#[cfg(not(unix))]
pub mod fd {
    use std::os::raw::c_int;

    pub type RawFd = c_int;

    pub trait AsRawFd {
        fn as_raw_fd(&self) -> RawFd;
    }
}

#[cfg(unix)]
pub use std::os::unix::io as fd;

impl fd::AsRawFd for RFile {
    #[cfg(ruby_gte_3_3)]
    fn as_raw_fd(&self) -> fd::RawFd {
        unsafe { rb_io_descriptor(self.as_rb_value()) }
    }
    #[cfg(ruby_lt_3_3)]
    fn as_raw_fd(&self) -> fd::RawFd {
        unsafe { (*self.as_internal().as_ref().fptr).fd }
    }
}