gio/auto/data_output_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 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
// 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::{ffi, Cancellable, DataStreamByteOrder, FilterOutputStream, OutputStream, Seekable};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// Data output stream implements [`OutputStream`][crate::OutputStream] and includes functions
/// for writing data directly to an output stream.
///
/// ## Properties
///
///
/// #### `byte-order`
/// Determines the byte ordering that is used when writing
/// multi-byte entities (such as integers) to the stream.
///
/// Readable | Writeable
/// <details><summary><h4>FilterOutputStream</h4></summary>
///
///
/// #### `base-stream`
/// Readable | Writeable | Construct Only
///
///
/// #### `close-base-stream`
/// Whether the base stream should be closed when the filter stream is closed.
///
/// Readable | Writeable | Construct Only
/// </details>
///
/// # Implements
///
/// [`DataOutputStreamExt`][trait@crate::prelude::DataOutputStreamExt], [`FilterOutputStreamExt`][trait@crate::prelude::FilterOutputStreamExt], [`OutputStreamExt`][trait@crate::prelude::OutputStreamExt], [`trait@glib::ObjectExt`], [`SeekableExt`][trait@crate::prelude::SeekableExt], [`OutputStreamExtManual`][trait@crate::prelude::OutputStreamExtManual]
#[doc(alias = "GDataOutputStream")]
pub struct DataOutputStream(Object<ffi::GDataOutputStream, ffi::GDataOutputStreamClass>) @extends FilterOutputStream, OutputStream, @implements Seekable;
match fn {
type_ => || ffi::g_data_output_stream_get_type(),
}
}
impl DataOutputStream {
pub const NONE: Option<&'static DataOutputStream> = None;
/// Creates a new data output stream for @base_stream.
/// ## `base_stream`
/// a #GOutputStream.
///
/// # Returns
///
/// #GDataOutputStream.
#[doc(alias = "g_data_output_stream_new")]
pub fn new(base_stream: &impl IsA<OutputStream>) -> DataOutputStream {
unsafe {
from_glib_full(ffi::g_data_output_stream_new(
base_stream.as_ref().to_glib_none().0,
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`DataOutputStream`] objects.
///
/// This method returns an instance of [`DataOutputStreamBuilder`](crate::builders::DataOutputStreamBuilder) which can be used to create [`DataOutputStream`] objects.
pub fn builder() -> DataOutputStreamBuilder {
DataOutputStreamBuilder::new()
}
}
impl Default for DataOutputStream {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`DataOutputStream`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct DataOutputStreamBuilder {
builder: glib::object::ObjectBuilder<'static, DataOutputStream>,
}
impl DataOutputStreamBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Determines the byte ordering that is used when writing
/// multi-byte entities (such as integers) to the stream.
pub fn byte_order(self, byte_order: DataStreamByteOrder) -> Self {
Self {
builder: self.builder.property("byte-order", byte_order),
}
}
pub fn base_stream(self, base_stream: &impl IsA<OutputStream>) -> Self {
Self {
builder: self
.builder
.property("base-stream", base_stream.clone().upcast()),
}
}
/// Whether the base stream should be closed when the filter stream is closed.
pub fn close_base_stream(self, close_base_stream: bool) -> Self {
Self {
builder: self
.builder
.property("close-base-stream", close_base_stream),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`DataOutputStream`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> DataOutputStream {
self.builder.build()
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::DataOutputStream>> Sealed for T {}
}
/// Trait containing all [`struct@DataOutputStream`] methods.
///
/// # Implementors
///
/// [`DataOutputStream`][struct@crate::DataOutputStream]
pub trait DataOutputStreamExt: IsA<DataOutputStream> + sealed::Sealed + 'static {
/// Gets the byte order for the stream.
///
/// # Returns
///
/// the #GDataStreamByteOrder for the @self.
#[doc(alias = "g_data_output_stream_get_byte_order")]
#[doc(alias = "get_byte_order")]
#[doc(alias = "byte-order")]
fn byte_order(&self) -> DataStreamByteOrder {
unsafe {
from_glib(ffi::g_data_output_stream_get_byte_order(
self.as_ref().to_glib_none().0,
))
}
}
/// Puts a byte into the output stream.
/// ## `data`
/// a #guchar.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_byte")]
fn put_byte(
&self,
data: u8,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_byte(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts a signed 16-bit integer into the output stream.
/// ## `data`
/// a #gint16.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_int16")]
fn put_int16(
&self,
data: i16,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_int16(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts a signed 32-bit integer into the output stream.
/// ## `data`
/// a #gint32.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_int32")]
fn put_int32(
&self,
data: i32,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_int32(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts a signed 64-bit integer into the stream.
/// ## `data`
/// a #gint64.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_int64")]
fn put_int64(
&self,
data: i64,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_int64(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts a string into the output stream.
/// ## `str`
/// a string.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @string was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_string")]
fn put_string(
&self,
str: &str,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_string(
self.as_ref().to_glib_none().0,
str.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))
}
}
}
/// Puts an unsigned 16-bit integer into the output stream.
/// ## `data`
/// a #guint16.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_uint16")]
fn put_uint16(
&self,
data: u16,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_uint16(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts an unsigned 32-bit integer into the stream.
/// ## `data`
/// a #guint32.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_uint32")]
fn put_uint32(
&self,
data: u32,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_uint32(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Puts an unsigned 64-bit integer into the stream.
/// ## `data`
/// a #guint64.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore.
///
/// # Returns
///
/// [`true`] if @data was successfully added to the @self.
#[doc(alias = "g_data_output_stream_put_uint64")]
fn put_uint64(
&self,
data: u64,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_data_output_stream_put_uint64(
self.as_ref().to_glib_none().0,
data,
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))
}
}
}
/// Sets the byte order of the data output stream to @order.
/// ## `order`
/// a `GDataStreamByteOrder`.
#[doc(alias = "g_data_output_stream_set_byte_order")]
#[doc(alias = "byte-order")]
fn set_byte_order(&self, order: DataStreamByteOrder) {
unsafe {
ffi::g_data_output_stream_set_byte_order(
self.as_ref().to_glib_none().0,
order.into_glib(),
);
}
}
#[doc(alias = "byte-order")]
fn connect_byte_order_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_byte_order_trampoline<
P: IsA<DataOutputStream>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GDataOutputStream,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(DataOutputStream::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::byte-order\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_byte_order_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<DataOutputStream>> DataOutputStreamExt for O {}