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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
// 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 glib::object::IsA;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem;
use std::pin::Pin;
use std::ptr;
glib::wrapper! {
/// [`InputStream`][crate::InputStream] has functions to read from a stream ([`InputStreamExtManual::read()`][crate::prelude::InputStreamExtManual::read()]),
/// to close a stream ([`InputStreamExt::close()`][crate::prelude::InputStreamExt::close()]) and to skip some content
/// ([`InputStreamExt::skip()`][crate::prelude::InputStreamExt::skip()]).
///
/// To copy the content of an input stream to an output stream without
/// manually handling the reads and writes, use [`OutputStreamExt::splice()`][crate::prelude::OutputStreamExt::splice()].
///
/// See the documentation for [`IOStream`][crate::IOStream] for details of thread safety of
/// streaming APIs.
///
/// All of these functions have async variants too.
///
/// This is an Abstract Base Class, you cannot instantiate it.
///
/// # Implements
///
/// [`InputStreamExt`][trait@crate::prelude::InputStreamExt], [`trait@glib::ObjectExt`], [`InputStreamExtManual`][trait@crate::prelude::InputStreamExtManual]
#[doc(alias = "GInputStream")]
pub struct InputStream(Object<ffi::GInputStream, ffi::GInputStreamClass>);
match fn {
type_ => || ffi::g_input_stream_get_type(),
}
}
impl InputStream {
pub const NONE: Option<&'static InputStream> = None;
}
/// Trait containing all [`struct@InputStream`] methods.
///
/// # Implementors
///
/// [`FileInputStream`][struct@crate::FileInputStream], [`FilterInputStream`][struct@crate::FilterInputStream], [`InputStream`][struct@crate::InputStream], [`MemoryInputStream`][struct@crate::MemoryInputStream], [`PollableInputStream`][struct@crate::PollableInputStream], [`UnixInputStream`][struct@crate::UnixInputStream]
pub trait InputStreamExt: 'static {
/// Clears the pending flag on `self`.
#[doc(alias = "g_input_stream_clear_pending")]
fn clear_pending(&self);
/// Closes the stream, releasing resources related to it.
///
/// 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.
///
/// 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.
///
/// If `cancellable` is not [`None`], 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.
/// ## `cancellable`
/// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] on success, [`false`] on failure
#[doc(alias = "g_input_stream_close")]
fn close(&self, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error>;
/// Requests an asynchronous closes of the stream, releasing resources related to it.
/// When the operation is finished `callback` will be called.
/// You can then call `g_input_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 [I/O priority][io-priority] of the request
/// ## `cancellable`
/// optional cancellable object
/// ## `callback`
/// callback to call when the request is satisfied
#[doc(alias = "g_input_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>>;
/// Checks if an input stream has pending actions.
///
/// # Returns
///
/// [`true`] if `self` has pending actions.
#[doc(alias = "g_input_stream_has_pending")]
fn has_pending(&self) -> bool;
/// Checks if an input stream is closed.
///
/// # Returns
///
/// [`true`] if the stream is closed.
#[doc(alias = "g_input_stream_is_closed")]
fn is_closed(&self) -> bool;
/// Like [`InputStreamExtManual::read()`][crate::prelude::InputStreamExtManual::read()], this tries to read `count` bytes from
/// the stream in a blocking fashion. However, rather than reading into
/// a user-supplied buffer, this will create a new [`glib::Bytes`][crate::glib::Bytes] containing
/// the data that was read. This may be easier to use from language
/// bindings.
///
/// If count is zero, returns a zero-length [`glib::Bytes`][crate::glib::Bytes] and does nothing. A
/// value of `count` larger than `G_MAXSSIZE` will cause a
/// [`IOErrorEnum::InvalidArgument`][crate::IOErrorEnum::InvalidArgument] error.
///
/// On success, a new [`glib::Bytes`][crate::glib::Bytes] is returned. It is not an error if the
/// size of this object is not the same as the requested size, as it
/// can happen e.g. near the end of a file. A zero-length [`glib::Bytes`][crate::glib::Bytes] is
/// returned on end of file (or if `count` is zero), but never
/// otherwise.
///
/// If `cancellable` is not [`None`], 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. If an
/// operation was partially finished when the operation was cancelled the
/// partial result will be returned, without an error.
///
/// On error [`None`] is returned and `error` is set accordingly.
/// ## `count`
/// maximum number of bytes that will be read from the stream. Common
/// values include 4096 and 8192.
/// ## `cancellable`
/// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
///
/// # Returns
///
/// a new [`glib::Bytes`][crate::glib::Bytes], or [`None`] on error
#[doc(alias = "g_input_stream_read_bytes")]
fn read_bytes(
&self,
count: usize,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<glib::Bytes, glib::Error>;
/// Request an asynchronous read of `count` bytes from the stream into a
/// new [`glib::Bytes`][crate::glib::Bytes]. When the operation is finished `callback` will be
/// called. You can then call `g_input_stream_read_bytes_finish()` to get the
/// result of the operation.
///
/// During an async request no other sync and async calls are allowed
/// on `self`, and will result in [`IOErrorEnum::Pending`][crate::IOErrorEnum::Pending] errors.
///
/// A value of `count` larger than `G_MAXSSIZE` will cause a
/// [`IOErrorEnum::InvalidArgument`][crate::IOErrorEnum::InvalidArgument] error.
///
/// On success, the new [`glib::Bytes`][crate::glib::Bytes] will be passed to the callback. It is
/// not an error if this is smaller than the requested size, as it can
/// happen e.g. near the end of a file, but generally we try to read as
/// many bytes as requested. Zero is returned on end of file (or if
/// `count` is zero), but never otherwise.
///
/// Any outstanding I/O request with higher priority (lower numerical
/// value) will be executed before an outstanding request with lower
/// priority. Default priority is `G_PRIORITY_DEFAULT`.
/// ## `count`
/// the number of bytes that will be read from the stream
/// ## `io_priority`
/// the [I/O priority][io-priority] of the request
/// ## `cancellable`
/// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
/// ## `callback`
/// callback to call when the request is satisfied
#[doc(alias = "g_input_stream_read_bytes_async")]
fn read_bytes_async<P: FnOnce(Result<glib::Bytes, glib::Error>) + 'static>(
&self,
count: usize,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
);
fn read_bytes_future(
&self,
count: usize,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<glib::Bytes, glib::Error>> + 'static>>;
/// 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_input_stream_set_pending")]
fn set_pending(&self) -> Result<(), glib::Error>;
/// Tries to skip `count` bytes from the stream. Will block during the operation.
///
/// This is identical to [`InputStreamExtManual::read()`][crate::prelude::InputStreamExtManual::read()], from a behaviour standpoint,
/// but the bytes that are skipped are not returned to the user. Some
/// streams have an implementation that is more efficient than reading the data.
///
/// This function is optional for inherited classes, as the default implementation
/// emulates it using read.
///
/// If `cancellable` is not [`None`], 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. If an
/// operation was partially finished when the operation was cancelled the
/// partial result will be returned, without an error.
/// ## `count`
/// the number of bytes that will be skipped from the stream
/// ## `cancellable`
/// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
///
/// # Returns
///
/// Number of bytes skipped, or -1 on error
#[doc(alias = "g_input_stream_skip")]
fn skip(
&self,
count: usize,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<isize, glib::Error>;
/// Request an asynchronous skip of `count` bytes from the stream.
/// When the operation is finished `callback` will be called.
/// You can then call `g_input_stream_skip_finish()` to get the result
/// of the operation.
///
/// During an async request no other sync and async calls are allowed,
/// and will result in [`IOErrorEnum::Pending`][crate::IOErrorEnum::Pending] errors.
///
/// A value of `count` larger than `G_MAXSSIZE` will cause a [`IOErrorEnum::InvalidArgument`][crate::IOErrorEnum::InvalidArgument] error.
///
/// On success, the number of bytes skipped will be passed to the callback.
/// It is not an error if this is not the same as the requested size, as it
/// can happen e.g. near the end of a file, but generally we try to skip
/// as many bytes as requested. Zero is returned on end of file
/// (or if `count` is zero), but never otherwise.
///
/// Any outstanding i/o request with higher priority (lower numerical value)
/// will be executed before an outstanding request with lower priority.
/// Default priority is `G_PRIORITY_DEFAULT`.
///
/// 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.
/// ## `count`
/// the number of bytes that will be skipped from the stream
/// ## `io_priority`
/// the [I/O priority][io-priority] of the request
/// ## `cancellable`
/// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
/// ## `callback`
/// callback to call when the request is satisfied
#[doc(alias = "g_input_stream_skip_async")]
fn skip_async<P: FnOnce(Result<isize, glib::Error>) + 'static>(
&self,
count: usize,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
);
fn skip_future(
&self,
count: usize,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<isize, glib::Error>> + 'static>>;
}
impl<O: IsA<InputStream>> InputStreamExt for O {
fn clear_pending(&self) {
unsafe {
ffi::g_input_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_input_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_input_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_input_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 has_pending(&self) -> bool {
unsafe {
from_glib(ffi::g_input_stream_has_pending(
self.as_ref().to_glib_none().0,
))
}
}
fn is_closed(&self) -> bool {
unsafe {
from_glib(ffi::g_input_stream_is_closed(
self.as_ref().to_glib_none().0,
))
}
}
fn read_bytes(
&self,
count: usize,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<glib::Bytes, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_input_stream_read_bytes(
self.as_ref().to_glib_none().0,
count,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
fn read_bytes_async<P: FnOnce(Result<glib::Bytes, glib::Error>) + 'static>(
&self,
count: usize,
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 read_bytes_async_trampoline<
P: FnOnce(Result<glib::Bytes, 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 ret =
ffi::g_input_stream_read_bytes_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} 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 = read_bytes_async_trampoline::<P>;
unsafe {
ffi::g_input_stream_read_bytes_async(
self.as_ref().to_glib_none().0,
count,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn read_bytes_future(
&self,
count: usize,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<glib::Bytes, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.read_bytes_async(count, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
fn set_pending(&self) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::g_input_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 skip(
&self,
count: usize,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<isize, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_input_stream_skip(
self.as_ref().to_glib_none().0,
count,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(ret)
} else {
Err(from_glib_full(error))
}
}
}
fn skip_async<P: FnOnce(Result<isize, glib::Error>) + 'static>(
&self,
count: usize,
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 skip_async_trampoline<
P: FnOnce(Result<isize, 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 ret = ffi::g_input_stream_skip_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(ret)
} 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 = skip_async_trampoline::<P>;
unsafe {
ffi::g_input_stream_skip_async(
self.as_ref().to_glib_none().0,
count,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn skip_future(
&self,
count: usize,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<isize, glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.skip_async(count, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
}
impl fmt::Display for InputStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("InputStream")
}
}