gio/auto/converter_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
// 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, Converter, FilterInputStream, InputStream, PollableInputStream};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// Converter input stream implements [`InputStream`][crate::InputStream] and allows
/// conversion of data of various types during reading.
///
/// As of GLib 2.34, `GConverterInputStream` implements
/// [`PollableInputStream`][crate::PollableInputStream].
///
/// ## Properties
///
///
/// #### `converter`
/// The converter object.
///
/// Readable | Writeable | Construct Only
/// <details><summary><h4>FilterInputStream</h4></summary>
///
///
/// #### `base-stream`
/// The underlying base stream on which the I/O ops will be done.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `close-base-stream`
/// Whether the base stream should be closed when the filter stream is closed.
///
/// Readable | Writeable | Construct
/// </details>
///
/// # Implements
///
/// [`ConverterInputStreamExt`][trait@crate::prelude::ConverterInputStreamExt], [`FilterInputStreamExt`][trait@crate::prelude::FilterInputStreamExt], [`InputStreamExt`][trait@crate::prelude::InputStreamExt], [`trait@glib::ObjectExt`], [`PollableInputStreamExt`][trait@crate::prelude::PollableInputStreamExt], [`InputStreamExtManual`][trait@crate::prelude::InputStreamExtManual], [`PollableInputStreamExtManual`][trait@crate::prelude::PollableInputStreamExtManual]
#[doc(alias = "GConverterInputStream")]
pub struct ConverterInputStream(Object<ffi::GConverterInputStream, ffi::GConverterInputStreamClass>) @extends FilterInputStream, InputStream, @implements PollableInputStream;
match fn {
type_ => || ffi::g_converter_input_stream_get_type(),
}
}
impl ConverterInputStream {
pub const NONE: Option<&'static ConverterInputStream> = None;
/// Creates a new converter input stream for the @base_stream.
/// ## `base_stream`
/// a #GInputStream
/// ## `converter`
/// a #GConverter
///
/// # Returns
///
/// a new #GInputStream.
#[doc(alias = "g_converter_input_stream_new")]
pub fn new(
base_stream: &impl IsA<InputStream>,
converter: &impl IsA<Converter>,
) -> ConverterInputStream {
unsafe {
InputStream::from_glib_full(ffi::g_converter_input_stream_new(
base_stream.as_ref().to_glib_none().0,
converter.as_ref().to_glib_none().0,
))
.unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`ConverterInputStream`] objects.
///
/// This method returns an instance of [`ConverterInputStreamBuilder`](crate::builders::ConverterInputStreamBuilder) which can be used to create [`ConverterInputStream`] objects.
pub fn builder() -> ConverterInputStreamBuilder {
ConverterInputStreamBuilder::new()
}
}
impl Default for ConverterInputStream {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ConverterInputStream`] 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 ConverterInputStreamBuilder {
builder: glib::object::ObjectBuilder<'static, ConverterInputStream>,
}
impl ConverterInputStreamBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The converter object.
pub fn converter(self, converter: &impl IsA<Converter>) -> Self {
Self {
builder: self
.builder
.property("converter", converter.clone().upcast()),
}
}
/// The underlying base stream on which the I/O ops will be done.
pub fn base_stream(self, base_stream: &impl IsA<InputStream>) -> 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 [`ConverterInputStream`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ConverterInputStream {
self.builder.build()
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::ConverterInputStream>> Sealed for T {}
}
/// Trait containing all [`struct@ConverterInputStream`] methods.
///
/// # Implementors
///
/// [`ConverterInputStream`][struct@crate::ConverterInputStream]
pub trait ConverterInputStreamExt: IsA<ConverterInputStream> + sealed::Sealed + 'static {
/// Gets the #GConverter that is used by @self.
///
/// # Returns
///
/// the converter of the converter input stream
#[doc(alias = "g_converter_input_stream_get_converter")]
#[doc(alias = "get_converter")]
fn converter(&self) -> Converter {
unsafe {
from_glib_none(ffi::g_converter_input_stream_get_converter(
self.as_ref().to_glib_none().0,
))
}
}
}
impl<O: IsA<ConverterInputStream>> ConverterInputStreamExt for O {}