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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
// 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;
use crate::Cancellable;
use crate::InputStream;
use crate::OutputStream;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::pin::Pin;
use std::ptr;
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 [`IOStream`][crate::IOStream] 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 [`IOStream`][crate::IOStream] object owns the input and the output streams, not the other
/// way around, so keeping the substreams alive will not keep the [`IOStream`][crate::IOStream]
/// object alive. If the [`IOStream`][crate::IOStream] object is freed it will be closed, thus
/// closing the substreams, so even if the substreams stay alive they will
/// always return [`IOErrorEnum::Closed`][crate::IOErrorEnum::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
/// [`IOStream`][crate::IOStream] may still be open. However, some streams may support
/// "half-closed" states where one direction of the stream is actually shut down.
///
/// Operations on `GIOStreams` cannot be started while another operation on the
/// [`IOStream`][crate::IOStream] 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 [`IOStream`][crate::IOStream] operation while there
/// is a [`IOStream`][crate::IOStream], [`InputStream`][crate::InputStream] or [`OutputStream`][crate::OutputStream] operation in progress, and
/// an application can’t start any [`InputStream`][crate::InputStream] or [`OutputStream`][crate::OutputStream] operation
/// while there is a [`IOStream`][crate::IOStream] operation in progress.
///
/// This is a product of individual stream operations being associated with a
/// given [`glib::MainContext`][crate::glib::MainContext] (the thread-default context at the time the operation was
/// started), rather than entire streams being associated with a single
/// [`glib::MainContext`][crate::glib::MainContext].
///
/// GIO may run operations on `GIOStreams` 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.
///
/// # 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: 'static {
/// Clears the pending flag on `self`.
#[doc(alias = "g_io_stream_clear_pending")]
fn clear_pending(&self);
/// 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 [`Cancellable`][crate::Cancellable] 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>;
/// 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 [`close()`][Self::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`
/// callback 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,
);
fn close_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>>;
/// Gets the input stream for this object. This is used
/// for reading.
///
/// # Returns
///
/// a [`InputStream`][crate::InputStream], owned by the [`IOStream`][crate::IOStream].
/// Do not free.
#[doc(alias = "g_io_stream_get_input_stream")]
#[doc(alias = "get_input_stream")]
fn input_stream(&self) -> InputStream;
/// Gets the output stream for this object. This is used for
/// writing.
///
/// # Returns
///
/// a [`OutputStream`][crate::OutputStream], owned by the [`IOStream`][crate::IOStream].
/// Do not free.
#[doc(alias = "g_io_stream_get_output_stream")]
#[doc(alias = "get_output_stream")]
fn output_stream(&self) -> OutputStream;
/// 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;
/// Checks if a stream is closed.
///
/// # Returns
///
/// [`true`] if the stream is closed.
#[doc(alias = "g_io_stream_is_closed")]
fn is_closed(&self) -> bool;
/// 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>;
#[doc(alias = "closed")]
fn connect_closed_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<IOStream>> IOStreamExt for O {
fn clear_pending(&self) {
unsafe {
ffi::g_io_stream_clear_pending(self.as_ref().to_glib_none().0);
}
}
fn close(&self, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error> {
unsafe {
let mut error = 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,
);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
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,
) {
let mut error = ptr::null_mut();
let _ = 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);
});
},
))
}
fn input_stream(&self) -> InputStream {
unsafe {
from_glib_none(ffi::g_io_stream_get_input_stream(
self.as_ref().to_glib_none().0,
))
}
}
fn output_stream(&self) -> OutputStream {
unsafe {
from_glib_none(ffi::g_io_stream_get_output_stream(
self.as_ref().to_glib_none().0,
))
}
}
fn has_pending(&self) -> bool {
unsafe { from_glib(ffi::g_io_stream_has_pending(self.as_ref().to_glib_none().0)) }
}
fn is_closed(&self) -> bool {
unsafe { from_glib(ffi::g_io_stream_is_closed(self.as_ref().to_glib_none().0)) }
}
fn set_pending(&self) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::g_io_stream_set_pending(self.as_ref().to_glib_none().0, &mut error);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
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,
) {
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 _,
b"notify::closed\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_closed_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for IOStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("IOStream")
}
}