gio/data_input_stream.rs
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
// Take a look at the license at the top of the repository in the LICENSE file.
use std::{boxed::Box as Box_, mem, pin::Pin, ptr};
use glib::{prelude::*, translate::*, GString};
use crate::{ffi, Cancellable, DataInputStream};
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::DataInputStream>> Sealed for T {}
}
pub trait DataInputStreamExtManual: sealed::Sealed + IsA<DataInputStream> + 'static {
/// Reads a line from the data input stream. Note that no encoding
/// checks or conversion is performed; the input is not guaranteed to
/// be UTF-8, and may in fact have embedded NUL characters.
///
/// 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.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
///
/// a NUL terminated byte array with the line that was read in
/// (without the newlines). Set @length to a #gsize to get the length
/// of the read line. On an error, it will return [`None`] and @error
/// will be set. If there's no content to read, it will still return
/// [`None`], but @error won't be set.
///
/// ## `length`
/// a #gsize to get the length of the data read in.
#[doc(alias = "g_data_input_stream_read_line")]
fn read_line<P: IsA<Cancellable>>(
&self,
cancellable: Option<&P>,
) -> Result<glib::collections::Slice<u8>, glib::Error> {
unsafe {
let mut length = mem::MaybeUninit::uninit();
let mut error = ptr::null_mut();
let ret = ffi::g_data_input_stream_read_line(
self.as_ref().to_glib_none().0,
length.as_mut_ptr(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
let length = length.assume_init();
if error.is_null() {
Ok(FromGlibContainer::from_glib_full_num(ret, length))
} else {
Err(from_glib_full(error))
}
}
}
/// The asynchronous version of g_data_input_stream_read_line(). It is
/// an error to have two outstanding calls to this function.
///
/// When the operation is finished, @callback will be called. You
/// can then call g_data_input_stream_read_line_finish() to get
/// the result of the operation.
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
/// ## `callback`
/// callback to call when the request is satisfied.
#[doc(alias = "g_data_input_stream_read_line_async")]
fn read_line_async<
P: IsA<Cancellable>,
Q: FnOnce(Result<glib::collections::Slice<u8>, glib::Error>) + 'static,
>(
&self,
io_priority: glib::Priority,
cancellable: Option<&P>,
callback: Q,
) {
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<Q>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn read_line_async_trampoline<
Q: FnOnce(Result<glib::collections::Slice<u8>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let mut length = mem::MaybeUninit::uninit();
let ret = ffi::g_data_input_stream_read_line_finish(
_source_object as *mut _,
res,
length.as_mut_ptr(),
&mut error,
);
let length = length.assume_init();
let result = if error.is_null() {
Ok(FromGlibContainer::from_glib_full_num(ret, length))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<Q>> =
Box_::from_raw(user_data as *mut _);
let callback = callback.into_inner();
callback(result);
}
let callback = read_line_async_trampoline::<Q>;
unsafe {
ffi::g_data_input_stream_read_line_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 read_line_future(
&self,
io_priority: glib::Priority,
) -> Pin<
Box_<
dyn std::future::Future<Output = Result<glib::collections::Slice<u8>, glib::Error>>
+ 'static,
>,
> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.read_line_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Reads a UTF-8 encoded line from the data input stream.
///
/// 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.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// a NUL terminated UTF-8 string
/// with the line that was read in (without the newlines). Set
/// @length to a #gsize to get the length of the read line. On an
/// error, it will return [`None`] and @error will be set. For UTF-8
/// conversion errors, the set error domain is `G_CONVERT_ERROR`. If
/// there's no content to read, it will still return [`None`], but @error
/// won't be set.
///
/// ## `length`
/// a #gsize to get the length of the data read in.
#[doc(alias = "g_data_input_stream_read_line_utf8")]
fn read_line_utf8<P: IsA<Cancellable>>(
&self,
cancellable: Option<&P>,
) -> Result<Option<GString>, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_data_input_stream_read_line_utf8(
self.as_ref().to_glib_none().0,
ptr::null_mut(),
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_line_utf8_async<
P: IsA<Cancellable>,
Q: FnOnce(Result<Option<GString>, glib::Error>) + 'static,
>(
&self,
io_priority: glib::Priority,
cancellable: Option<&P>,
callback: Q,
) {
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<Q>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn read_line_async_trampoline<
Q: FnOnce(Result<Option<GString>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let ret = ffi::g_data_input_stream_read_line_finish(
_source_object as *mut _,
res,
ptr::null_mut(),
&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<Q>> =
Box_::from_raw(user_data as *mut _);
let callback = callback.into_inner();
callback(result);
}
let callback = read_line_async_trampoline::<Q>;
unsafe {
ffi::g_data_input_stream_read_line_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 read_line_utf8_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<Option<GString>, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.read_line_utf8_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Reads a string from the data input stream, up to the first
/// occurrence of any of the stop characters.
///
/// In contrast to g_data_input_stream_read_until(), this function
/// does not consume the stop character. You have to use
/// g_data_input_stream_read_byte() to get it before calling
/// g_data_input_stream_read_upto() again.
///
/// Note that @stop_chars may contain '\0' if @stop_chars_len is
/// specified.
///
/// The returned string will always be nul-terminated on success.
/// ## `stop_chars`
/// characters to terminate the read
/// ## `stop_chars_len`
/// length of @stop_chars. May be -1 if @stop_chars is
/// nul-terminated
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
///
/// # Returns
///
/// a string with the data that was read
/// before encountering any of the stop characters. Set @length to
/// a #gsize to get the length of the string. This function will
/// return [`None`] on an error
///
/// ## `length`
/// a #gsize to get the length of the data read in
#[doc(alias = "g_data_input_stream_read_upto")]
fn read_upto<P: IsA<Cancellable>>(
&self,
stop_chars: &[u8],
cancellable: Option<&P>,
) -> Result<glib::collections::Slice<u8>, glib::Error> {
let stop_chars_len = stop_chars.len() as isize;
unsafe {
let mut error = ptr::null_mut();
let mut length = mem::MaybeUninit::uninit();
let ret = ffi::g_data_input_stream_read_upto(
self.as_ref().to_glib_none().0,
stop_chars.to_glib_none().0 as *const _,
stop_chars_len,
length.as_mut_ptr(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
let length = length.assume_init();
Ok(FromGlibContainer::from_glib_full_num(
ret as *mut u8,
length,
))
} else {
Err(from_glib_full(error))
}
}
}
/// The asynchronous version of g_data_input_stream_read_upto().
/// It is an error to have two outstanding calls to this function.
///
/// In contrast to g_data_input_stream_read_until(), this function
/// does not consume the stop character. You have to use
/// g_data_input_stream_read_byte() to get it before calling
/// g_data_input_stream_read_upto() again.
///
/// Note that @stop_chars may contain '\0' if @stop_chars_len is
/// specified.
///
/// When the operation is finished, @callback will be called. You
/// can then call g_data_input_stream_read_upto_finish() to get
/// the result of the operation.
/// ## `stop_chars`
/// characters to terminate the read
/// ## `stop_chars_len`
/// length of @stop_chars. May be -1 if @stop_chars is
/// nul-terminated
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
/// ## `callback`
/// callback to call when the request is satisfied
#[doc(alias = "g_data_input_stream_read_upto_async")]
fn read_upto_async<
P: IsA<Cancellable>,
Q: FnOnce(Result<glib::collections::Slice<u8>, glib::Error>) + 'static,
>(
&self,
stop_chars: &[u8],
io_priority: glib::Priority,
cancellable: Option<&P>,
callback: Q,
) {
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 stop_chars_len = stop_chars.len() as isize;
let user_data: Box_<glib::thread_guard::ThreadGuard<Q>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn read_upto_async_trampoline<
Q: FnOnce(Result<glib::collections::Slice<u8>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let mut length = mem::MaybeUninit::uninit();
let ret = ffi::g_data_input_stream_read_upto_finish(
_source_object as *mut _,
res,
length.as_mut_ptr(),
&mut error,
);
let result = if error.is_null() {
let length = length.assume_init();
Ok(FromGlibContainer::from_glib_full_num(
ret as *mut u8,
length,
))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<Q>> =
Box_::from_raw(user_data as *mut _);
let callback = callback.into_inner();
callback(result);
}
let callback = read_upto_async_trampoline::<Q>;
unsafe {
ffi::g_data_input_stream_read_upto_async(
self.as_ref().to_glib_none().0,
stop_chars.to_glib_none().0 as *const _,
stop_chars_len,
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_upto_future(
&self,
stop_chars: &[u8],
io_priority: glib::Priority,
) -> Pin<
Box_<
dyn std::future::Future<Output = Result<glib::collections::Slice<u8>, glib::Error>>
+ 'static,
>,
> {
let stop_chars = Vec::from(stop_chars);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.read_upto_async(&stop_chars, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
}
impl<O: IsA<DataInputStream>> DataInputStreamExtManual for O {}