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};
11
12impl OutputStream {
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) -> OutputStream {
17        let fd = fd.into_raw_fd();
18        let close_fd = true.into_glib();
19        unsafe {
20            gio::OutputStream::from_glib_full(ffi::g_unix_output_stream_new(fd, close_fd))
21                .unsafe_cast()
22        }
23    }
24
25    // rustdoc-stripper-ignore-next
26    /// Creates a new [`Self`] that does not take ownership of the passed in fd.
27    ///
28    /// # Safety
29    /// You may only close the fd if all references to this stream have been dropped.
30    #[doc(alias = "g_unix_output_stream_new")]
31    pub unsafe fn with_fd<T: AsRawFd>(fd: T) -> OutputStream {
32        let fd = fd.as_raw_fd();
33        let close_fd = false.into_glib();
34        gio::OutputStream::from_glib_full(ffi::g_unix_output_stream_new(fd, close_fd)).unsafe_cast()
35    }
36}
37
38impl AsRawFd for OutputStream {
39    fn as_raw_fd(&self) -> RawFd {
40        unsafe { ffi::g_unix_output_stream_get_fd(self.to_glib_none().0) as _ }
41    }
42}
43
44impl AsFd for OutputStream {
45    fn as_fd(&self) -> BorrowedFd<'_> {
46        unsafe {
47            let raw_fd = self.as_raw_fd();
48            BorrowedFd::borrow_raw(raw_fd)
49        }
50    }
51}
52
53pub trait UnixOutputStreamExtManual: IsA<OutputStream> + Sized {
54    // rustdoc-stripper-ignore-next
55    /// Sets whether the fd of this stream will be closed when the stream is closed.
56    ///
57    /// # Safety
58    /// If you pass in `false` as the parameter, you may only close the fd if the all references
59    /// to the stream have been dropped. If you pass in `true`, you must never call close.
60    #[doc(alias = "g_unix_output_stream_set_close_fd")]
61    unsafe fn set_close_fd(&self, close_fd: bool) {
62        ffi::g_unix_output_stream_set_close_fd(
63            self.as_ref().to_glib_none().0,
64            close_fd.into_glib(),
65        );
66    }
67}
68
69impl<O: IsA<OutputStream>> UnixOutputStreamExtManual for O {}