gio/
unix_output_stream.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3#[cfg(unix)]
4use std::os::unix::io::{AsFd, AsRawFd, BorrowedFd, IntoRawFd, OwnedFd, RawFd};
5
6use glib::{prelude::*, translate::*};
7#[cfg(all(not(unix), docsrs))]
8use socket::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
9
10use crate::{ffi, OutputStream, UnixOutputStream};
11
12impl UnixOutputStream {
13    // rustdoc-stripper-ignore-next
14    /// Creates a new [`Self`] that takes ownership of the passed in fd.
15    #[doc(alias = "g_unix_output_stream_new")]
16    pub fn take_fd(fd: OwnedFd) -> UnixOutputStream {
17        let fd = fd.into_raw_fd();
18        let close_fd = true.into_glib();
19        unsafe {
20            OutputStream::from_glib_full(ffi::g_unix_output_stream_new(fd, close_fd)).unsafe_cast()
21        }
22    }
23
24    // rustdoc-stripper-ignore-next
25    /// Creates a new [`Self`] that does not take ownership of the passed in fd.
26    ///
27    /// # Safety
28    /// You may only close the fd if all references to this stream have been dropped.
29    #[doc(alias = "g_unix_output_stream_new")]
30    pub unsafe fn with_fd<T: AsRawFd>(fd: T) -> UnixOutputStream {
31        let fd = fd.as_raw_fd();
32        let close_fd = false.into_glib();
33        OutputStream::from_glib_full(ffi::g_unix_output_stream_new(fd, close_fd)).unsafe_cast()
34    }
35}
36
37impl AsRawFd for UnixOutputStream {
38    fn as_raw_fd(&self) -> RawFd {
39        unsafe { ffi::g_unix_output_stream_get_fd(self.to_glib_none().0) as _ }
40    }
41}
42
43impl AsFd for UnixOutputStream {
44    fn as_fd(&self) -> BorrowedFd<'_> {
45        unsafe {
46            let raw_fd = self.as_raw_fd();
47            BorrowedFd::borrow_raw(raw_fd)
48        }
49    }
50}
51
52pub trait UnixOutputStreamExtManual: IsA<UnixOutputStream> + Sized {
53    // rustdoc-stripper-ignore-next
54    /// Sets whether the fd of this stream will be closed when the stream is closed.
55    ///
56    /// # Safety
57    /// If you pass in `false` as the parameter, you may only close the fd if the all references
58    /// to the stream have been dropped. If you pass in `true`, you must never call close.
59    #[doc(alias = "g_unix_output_stream_set_close_fd")]
60    unsafe fn set_close_fd(&self, close_fd: bool) {
61        ffi::g_unix_output_stream_set_close_fd(
62            self.as_ref().to_glib_none().0,
63            close_fd.into_glib(),
64        );
65    }
66}
67
68impl<O: IsA<UnixOutputStream>> UnixOutputStreamExtManual for O {}