gio/auto/

io_stream.rs

// 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::{AsyncResult, Cancellable, InputStream, OutputStream, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::{boxed::Box as Box_, pin::Pin};

glib::wrapper! {
    /// `GIOStream` represents an object that has both read and write streams.
    /// Generally the two streams act as separate input and output streams,
    /// but they share some common resources and state. For instance, for
    /// seekable streams, both streams may use the same position.
    ///
    /// Examples of `GIOStream` objects are [`SocketConnection`][crate::SocketConnection], which represents
    /// a two-way network connection; and [`FileIOStream`][crate::FileIOStream], which represents a
    /// file handle opened in read-write mode.
    ///
    /// To do the actual reading and writing you need to get the substreams
    /// with [`IOStreamExt::input_stream()`][crate::prelude::IOStreamExt::input_stream()] and
    /// [`IOStreamExt::output_stream()`][crate::prelude::IOStreamExt::output_stream()].
    ///
    /// The `GIOStream` object owns the input and the output streams, not the other
    /// way around, so keeping the substreams alive will not keep the `GIOStream`
    /// object alive. If the `GIOStream` object is freed it will be closed, thus
    /// closing the substreams, so even if the substreams stay alive they will
    /// always return `G_IO_ERROR_CLOSED` for all operations.
    ///
    /// To close a stream use [`IOStreamExt::close()`][crate::prelude::IOStreamExt::close()] which will close the common
    /// stream object and also the individual substreams. You can also close
    /// the substreams themselves. In most cases this only marks the
    /// substream as closed, so further I/O on it fails but common state in the
    /// `GIOStream` may still be open. However, some streams may support
    /// ‘half-closed’ states where one direction of the stream is actually shut down.
    ///
    /// Operations on `GIOStream`s cannot be started while another operation on the
    /// `GIOStream` or its substreams is in progress. Specifically, an application can
    /// read from the [`InputStream`][crate::InputStream] and write to the
    /// [`OutputStream`][crate::OutputStream] simultaneously (either in separate threads, or as
    /// asynchronous operations in the same thread), but an application cannot start
    /// any `GIOStream` operation while there is a `GIOStream`, `GInputStream` or
    /// `GOutputStream` operation in progress, and an application can’t start any
    /// `GInputStream` or `GOutputStream` operation while there is a `GIOStream`
    /// operation in progress.
    ///
    /// This is a product of individual stream operations being associated with a
    /// given [type@GLib.MainContext] (the thread-default context at the time the
    /// operation was started), rather than entire streams being associated with a
    /// single `GMainContext`.
    ///
    /// GIO may run operations on `GIOStream`s from other (worker) threads, and this
    /// may be exposed to application code in the behaviour of wrapper streams, such
    /// as [`BufferedInputStream`][crate::BufferedInputStream] or [`TlsConnection`][crate::TlsConnection]. With such
    /// wrapper APIs, application code may only run operations on the base (wrapped)
    /// stream when the wrapper stream is idle. Note that the semantics of such
    /// operations may not be well-defined due to the state the wrapper stream leaves
    /// the base stream in (though they are guaranteed not to crash).
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `closed`
    ///  Whether the stream is closed.
    ///
    /// Readable
    ///
    ///
    /// #### `input-stream`
    ///  The [`InputStream`][crate::InputStream] to read from.
    ///
    /// Readable
    ///
    ///
    /// #### `output-stream`
    ///  The [`OutputStream`][crate::OutputStream] to write to.
    ///
    /// Readable
    ///
    /// # Implements
    ///
    /// [`IOStreamExt`][trait@crate::prelude::IOStreamExt], [`trait@glib::ObjectExt`], [`IOStreamExtManual`][trait@crate::prelude::IOStreamExtManual]
    #[doc(alias = "GIOStream")]
    pub struct IOStream(Object<ffi::GIOStream, ffi::GIOStreamClass>);

    match fn {
        type_ => || ffi::g_io_stream_get_type(),
    }
}

impl IOStream {
    pub const NONE: Option<&'static IOStream> = None;
}

/// Trait containing all [`struct@IOStream`] methods.
///
/// # Implementors
///
/// [`FileIOStream`][struct@crate::FileIOStream], [`IOStream`][struct@crate::IOStream], [`SimpleIOStream`][struct@crate::SimpleIOStream], [`SocketConnection`][struct@crate::SocketConnection], [`TlsConnection`][struct@crate::TlsConnection]
pub trait IOStreamExt: IsA<IOStream> + 'static {
    /// Clears the pending flag on @self.
    #[doc(alias = "g_io_stream_clear_pending")]
    fn clear_pending(&self) {
        unsafe {
            ffi::g_io_stream_clear_pending(self.as_ref().to_glib_none().0);
        }
    }

    /// Closes the stream, releasing resources related to it. This will also
    /// close the individual input and output streams, if they are not already
    /// closed.
    ///
    /// Once the stream is closed, all other operations will return
    /// [`IOErrorEnum::Closed`][crate::IOErrorEnum::Closed]. Closing a stream multiple times will not
    /// return an error.
    ///
    /// Closing a stream will automatically flush any outstanding buffers
    /// in the stream.
    ///
    /// Streams will be automatically closed when the last reference
    /// is dropped, but you might want to call this function to make sure
    /// resources are released as early as possible.
    ///
    /// Some streams might keep the backing store of the stream (e.g. a file
    /// descriptor) open after the stream is closed. See the documentation for
    /// the individual stream for details.
    ///
    /// On failure the first error that happened will be reported, but the
    /// close operation will finish as much as possible. A stream that failed
    /// to close will still return [`IOErrorEnum::Closed`][crate::IOErrorEnum::Closed] for all operations.
    /// Still, it is important to check and report the error to the user,
    /// otherwise there might be a loss of data as all data might not be written.
    ///
    /// If @cancellable is not NULL, then the operation can be cancelled by
    /// triggering the cancellable object from another thread. If the operation
    /// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
    /// Cancelling a close will still leave the stream closed, but some streams
    /// can use a faster close that doesn't block to e.g. check errors.
    ///
    /// The default implementation of this method just calls close on the
    /// individual input/output streams.
    /// ## `cancellable`
    /// optional #GCancellable object, [`None`] to ignore
    ///
    /// # Returns
    ///
    /// [`true`] on success, [`false`] on failure
    #[doc(alias = "g_io_stream_close")]
    fn close(&self, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_io_stream_close(
                self.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Requests an asynchronous close of the stream, releasing resources
    /// related to it. When the operation is finished @callback will be
    /// called. You can then call g_io_stream_close_finish() to get
    /// the result of the operation.
    ///
    /// For behaviour details see g_io_stream_close().
    ///
    /// The asynchronous methods have a default fallback that uses threads
    /// to implement asynchronicity, so they are optional for inheriting
    /// classes. However, if you override one you must override all.
    /// ## `io_priority`
    /// the io priority of the request
    /// ## `cancellable`
    /// optional cancellable object
    /// ## `callback`
    /// a #GAsyncReadyCallback
    ///   to call when the request is satisfied
    #[doc(alias = "g_io_stream_close_async")]
    fn close_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
        &self,
        io_priority: glib::Priority,
        cancellable: Option<&impl IsA<Cancellable>>,
        callback: P,
    ) {
        let main_context = glib::MainContext::ref_thread_default();
        let is_main_context_owner = main_context.is_owner();
        let has_acquired_main_context = (!is_main_context_owner)
            .then(|| main_context.acquire().ok())
            .flatten();
        assert!(
            is_main_context_owner || has_acquired_main_context.is_some(),
            "Async operations only allowed if the thread is owning the MainContext"
        );

        let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
            Box_::new(glib::thread_guard::ThreadGuard::new(callback));
        unsafe extern "C" fn close_async_trampoline<
            P: FnOnce(Result<(), glib::Error>) + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut crate::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            unsafe {
                let mut error = std::ptr::null_mut();
                ffi::g_io_stream_close_finish(_source_object as *mut _, res, &mut error);
                let result = if error.is_null() {
                    Ok(())
                } else {
                    Err(from_glib_full(error))
                };
                let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
                    Box_::from_raw(user_data as *mut _);
                let callback: P = callback.into_inner();
                callback(result);
            }
        }
        let callback = close_async_trampoline::<P>;
        unsafe {
            ffi::g_io_stream_close_async(
                self.as_ref().to_glib_none().0,
                io_priority.into_glib(),
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    fn close_future(
        &self,
        io_priority: glib::Priority,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
        Box_::pin(crate::GioFuture::new(
            self,
            move |obj, cancellable, send| {
                obj.close_async(io_priority, Some(cancellable), move |res| {
                    send.resolve(res);
                });
            },
        ))
    }

    /// Gets the input stream for this object. This is used
    /// for reading.
    ///
    /// # Returns
    ///
    /// a #GInputStream, owned by the #GIOStream.
    /// Do not free.
    #[doc(alias = "g_io_stream_get_input_stream")]
    #[doc(alias = "get_input_stream")]
    #[doc(alias = "input-stream")]
    fn input_stream(&self) -> InputStream {
        unsafe {
            from_glib_none(ffi::g_io_stream_get_input_stream(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the output stream for this object. This is used for
    /// writing.
    ///
    /// # Returns
    ///
    /// a #GOutputStream, owned by the #GIOStream.
    /// Do not free.
    #[doc(alias = "g_io_stream_get_output_stream")]
    #[doc(alias = "get_output_stream")]
    #[doc(alias = "output-stream")]
    fn output_stream(&self) -> OutputStream {
        unsafe {
            from_glib_none(ffi::g_io_stream_get_output_stream(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Checks if a stream has pending actions.
    ///
    /// # Returns
    ///
    /// [`true`] if @self has pending actions.
    #[doc(alias = "g_io_stream_has_pending")]
    fn has_pending(&self) -> bool {
        unsafe { from_glib(ffi::g_io_stream_has_pending(self.as_ref().to_glib_none().0)) }
    }

    /// Checks if a stream is closed.
    ///
    /// # Returns
    ///
    /// [`true`] if the stream is closed.
    #[doc(alias = "g_io_stream_is_closed")]
    #[doc(alias = "closed")]
    fn is_closed(&self) -> bool {
        unsafe { from_glib(ffi::g_io_stream_is_closed(self.as_ref().to_glib_none().0)) }
    }

    /// Sets @self to have actions pending. If the pending flag is
    /// already set or @self is closed, it will return [`false`] and set
    /// @error.
    ///
    /// # Returns
    ///
    /// [`true`] if pending was previously unset and is now set.
    #[doc(alias = "g_io_stream_set_pending")]
    fn set_pending(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_io_stream_set_pending(self.as_ref().to_glib_none().0, &mut error);
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    #[doc(alias = "closed")]
    fn connect_closed_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_closed_trampoline<P: IsA<IOStream>, F: Fn(&P) + 'static>(
            this: *mut ffi::GIOStream,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(IOStream::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::closed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_closed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<IOStream>> IOStreamExt for O {}