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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{FileDescriptorBased, InputStream, PollableInputStream};
use glib::{prelude::*, translate::*};
use std::fmt;
glib::wrapper! {
/// [`UnixInputStream`][crate::UnixInputStream] implements [`InputStream`][crate::InputStream] for reading from a UNIX
/// file descriptor, including asynchronous operations. (If the file
/// descriptor refers to a socket or pipe, this will use `poll()` to do
/// asynchronous I/O. If it refers to a regular file, it will fall back
/// to doing asynchronous I/O in another thread.)
///
/// Note that `<gio/gunixinputstream.h>` belongs to the UNIX-specific GIO
/// interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
/// file when using it.
///
/// ## Properties
///
///
/// #### `close-fd`
/// Whether to close the file descriptor when the stream is closed.
///
/// Readable | Writeable
///
///
/// #### `fd`
/// The file descriptor that the stream reads from.
///
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`UnixInputStreamExt`][trait@crate::prelude::UnixInputStreamExt], [`InputStreamExt`][trait@crate::prelude::InputStreamExt], [`trait@glib::ObjectExt`], [`FileDescriptorBasedExt`][trait@crate::prelude::FileDescriptorBasedExt], [`PollableInputStreamExt`][trait@crate::prelude::PollableInputStreamExt], [`UnixInputStreamExtManual`][trait@crate::prelude::UnixInputStreamExtManual], [`InputStreamExtManual`][trait@crate::prelude::InputStreamExtManual], [`FileDescriptorBasedExtManual`][trait@crate::prelude::FileDescriptorBasedExtManual], [`PollableInputStreamExtManual`][trait@crate::prelude::PollableInputStreamExtManual]
#[doc(alias = "GUnixInputStream")]
pub struct UnixInputStream(Object<ffi::GUnixInputStream, ffi::GUnixInputStreamClass>) @extends InputStream, @implements FileDescriptorBased, PollableInputStream;
match fn {
type_ => || ffi::g_unix_input_stream_get_type(),
}
}
impl UnixInputStream {
pub const NONE: Option<&'static UnixInputStream> = None;
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::UnixInputStream>> Sealed for T {}
}
/// Trait containing all [`struct@UnixInputStream`] methods.
///
/// # Implementors
///
/// [`UnixInputStream`][struct@crate::UnixInputStream]
pub trait UnixInputStreamExt: IsA<UnixInputStream> + sealed::Sealed + 'static {
/// Returns whether the file descriptor of `self` will be
/// closed when the stream is closed.
///
/// # Returns
///
/// [`true`] if the file descriptor is closed when done
#[doc(alias = "g_unix_input_stream_get_close_fd")]
#[doc(alias = "get_close_fd")]
fn closes_fd(&self) -> bool {
unsafe {
from_glib(ffi::g_unix_input_stream_get_close_fd(
self.as_ref().to_glib_none().0,
))
}
}
}
impl<O: IsA<UnixInputStream>> UnixInputStreamExt for O {}
impl fmt::Display for UnixInputStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("UnixInputStream")
}
}