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
// 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::{FilterOutputStream, OutputStream, Seekable};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// Buffered output stream implements [`FilterOutputStream`][crate::FilterOutputStream] and provides
/// for buffered writes.
///
/// By default, `GBufferedOutputStream`'s buffer size is set at 4 kilobytes.
///
/// To create a buffered output stream, use [`new()`][Self::new()],
/// or [`new_sized()`][Self::new_sized()] to specify the buffer's size
/// at construction.
///
/// To get the size of a buffer within a buffered input stream, use
/// [`BufferedOutputStreamExt::buffer_size()`][crate::prelude::BufferedOutputStreamExt::buffer_size()]. To change the size of a
/// buffered output stream's buffer, use [`BufferedOutputStreamExt::set_buffer_size()`][crate::prelude::BufferedOutputStreamExt::set_buffer_size()].
/// Note that the buffer's size cannot be reduced below the size of the data within the buffer.
///
/// ## Properties
///
///
/// #### `auto-grow`
/// Whether the buffer should automatically grow.
///
/// Readable | Writeable
///
///
/// #### `buffer-size`
/// The size of the backend buffer, in bytes.
///
/// Readable | Writeable | Construct
/// <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
///
/// [`BufferedOutputStreamExt`][trait@crate::prelude::BufferedOutputStreamExt], [`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 = "GBufferedOutputStream")]
pub struct BufferedOutputStream(Object<ffi::GBufferedOutputStream, ffi::GBufferedOutputStreamClass>) @extends FilterOutputStream, OutputStream, @implements Seekable;
match fn {
type_ => || ffi::g_buffered_output_stream_get_type(),
}
}
impl BufferedOutputStream {
pub const NONE: Option<&'static BufferedOutputStream> = None;
/// Creates a new buffered output stream for a base stream.
/// ## `base_stream`
/// a #GOutputStream.
///
/// # Returns
///
/// a #GOutputStream for the given @base_stream.
#[doc(alias = "g_buffered_output_stream_new")]
pub fn new(base_stream: &impl IsA<OutputStream>) -> BufferedOutputStream {
unsafe {
OutputStream::from_glib_full(ffi::g_buffered_output_stream_new(
base_stream.as_ref().to_glib_none().0,
))
.unsafe_cast()
}
}
/// Creates a new buffered output stream with a given buffer size.
/// ## `base_stream`
/// a #GOutputStream.
/// ## `size`
/// a #gsize.
///
/// # Returns
///
/// a #GOutputStream with an internal buffer set to @size.
#[doc(alias = "g_buffered_output_stream_new_sized")]
pub fn new_sized(base_stream: &impl IsA<OutputStream>, size: usize) -> BufferedOutputStream {
unsafe {
OutputStream::from_glib_full(ffi::g_buffered_output_stream_new_sized(
base_stream.as_ref().to_glib_none().0,
size,
))
.unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`BufferedOutputStream`] objects.
///
/// This method returns an instance of [`BufferedOutputStreamBuilder`](crate::builders::BufferedOutputStreamBuilder) which can be used to create [`BufferedOutputStream`] objects.
pub fn builder() -> BufferedOutputStreamBuilder {
BufferedOutputStreamBuilder::new()
}
}
impl Default for BufferedOutputStream {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`BufferedOutputStream`] 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 BufferedOutputStreamBuilder {
builder: glib::object::ObjectBuilder<'static, BufferedOutputStream>,
}
impl BufferedOutputStreamBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Whether the buffer should automatically grow.
pub fn auto_grow(self, auto_grow: bool) -> Self {
Self {
builder: self.builder.property("auto-grow", auto_grow),
}
}
/// The size of the backend buffer, in bytes.
pub fn buffer_size(self, buffer_size: u32) -> Self {
Self {
builder: self.builder.property("buffer-size", buffer_size),
}
}
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 [`BufferedOutputStream`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> BufferedOutputStream {
self.builder.build()
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::BufferedOutputStream>> Sealed for T {}
}
/// Trait containing all [`struct@BufferedOutputStream`] methods.
///
/// # Implementors
///
/// [`BufferedOutputStream`][struct@crate::BufferedOutputStream]
pub trait BufferedOutputStreamExt: IsA<BufferedOutputStream> + sealed::Sealed + 'static {
/// Checks if the buffer automatically grows as data is added.
///
/// # Returns
///
/// [`true`] if the @self's buffer automatically grows,
/// [`false`] otherwise.
#[doc(alias = "g_buffered_output_stream_get_auto_grow")]
#[doc(alias = "get_auto_grow")]
fn auto_grows(&self) -> bool {
unsafe {
from_glib(ffi::g_buffered_output_stream_get_auto_grow(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the size of the buffer in the @self.
///
/// # Returns
///
/// the current size of the buffer.
#[doc(alias = "g_buffered_output_stream_get_buffer_size")]
#[doc(alias = "get_buffer_size")]
fn buffer_size(&self) -> usize {
unsafe { ffi::g_buffered_output_stream_get_buffer_size(self.as_ref().to_glib_none().0) }
}
/// Sets whether or not the @self's buffer should automatically grow.
/// If @auto_grow is true, then each write will just make the buffer
/// larger, and you must manually flush the buffer to actually write out
/// the data to the underlying stream.
/// ## `auto_grow`
/// a #gboolean.
#[doc(alias = "g_buffered_output_stream_set_auto_grow")]
fn set_auto_grow(&self, auto_grow: bool) {
unsafe {
ffi::g_buffered_output_stream_set_auto_grow(
self.as_ref().to_glib_none().0,
auto_grow.into_glib(),
);
}
}
/// Sets the size of the internal buffer to @size.
/// ## `size`
/// a #gsize.
#[doc(alias = "g_buffered_output_stream_set_buffer_size")]
fn set_buffer_size(&self, size: usize) {
unsafe {
ffi::g_buffered_output_stream_set_buffer_size(self.as_ref().to_glib_none().0, size);
}
}
#[doc(alias = "auto-grow")]
fn connect_auto_grow_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_auto_grow_trampoline<
P: IsA<BufferedOutputStream>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GBufferedOutputStream,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(BufferedOutputStream::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::auto-grow\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_auto_grow_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "buffer-size")]
fn connect_buffer_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_buffer_size_trampoline<
P: IsA<BufferedOutputStream>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GBufferedOutputStream,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(BufferedOutputStream::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::buffer-size\0".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
notify_buffer_size_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<BufferedOutputStream>> BufferedOutputStreamExt for O {}