gio/auto/converter_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
// 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, FilterOutputStream, OutputStream, PollableOutputStream};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// Converter output stream implements [`OutputStream`][crate::OutputStream] and allows
/// conversion of data of various types during reading.
///
/// As of GLib 2.34, `GConverterOutputStream` implements
/// [`PollableOutputStream`][crate::PollableOutputStream].
///
/// ## Properties
///
///
/// #### `converter`
/// The converter object.
///
/// Readable | Writeable | Construct Only
/// <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
///
/// [`ConverterOutputStreamExt`][trait@crate::prelude::ConverterOutputStreamExt], [`FilterOutputStreamExt`][trait@crate::prelude::FilterOutputStreamExt], [`OutputStreamExt`][trait@crate::prelude::OutputStreamExt], [`trait@glib::ObjectExt`], [`PollableOutputStreamExt`][trait@crate::prelude::PollableOutputStreamExt], [`OutputStreamExtManual`][trait@crate::prelude::OutputStreamExtManual], [`PollableOutputStreamExtManual`][trait@crate::prelude::PollableOutputStreamExtManual]
#[doc(alias = "GConverterOutputStream")]
pub struct ConverterOutputStream(Object<ffi::GConverterOutputStream, ffi::GConverterOutputStreamClass>) @extends FilterOutputStream, OutputStream, @implements PollableOutputStream;
match fn {
type_ => || ffi::g_converter_output_stream_get_type(),
}
}
impl ConverterOutputStream {
pub const NONE: Option<&'static ConverterOutputStream> = None;
/// Creates a new converter output stream for the @base_stream.
/// ## `base_stream`
/// a #GOutputStream
/// ## `converter`
/// a #GConverter
///
/// # Returns
///
/// a new #GOutputStream.
#[doc(alias = "g_converter_output_stream_new")]
pub fn new(
base_stream: &impl IsA<OutputStream>,
converter: &impl IsA<Converter>,
) -> ConverterOutputStream {
unsafe {
OutputStream::from_glib_full(ffi::g_converter_output_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 [`ConverterOutputStream`] objects.
///
/// This method returns an instance of [`ConverterOutputStreamBuilder`](crate::builders::ConverterOutputStreamBuilder) which can be used to create [`ConverterOutputStream`] objects.
pub fn builder() -> ConverterOutputStreamBuilder {
ConverterOutputStreamBuilder::new()
}
}
impl Default for ConverterOutputStream {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ConverterOutputStream`] 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 ConverterOutputStreamBuilder {
builder: glib::object::ObjectBuilder<'static, ConverterOutputStream>,
}
impl ConverterOutputStreamBuilder {
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()),
}
}
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 [`ConverterOutputStream`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ConverterOutputStream {
self.builder.build()
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::ConverterOutputStream>> Sealed for T {}
}
/// Trait containing all [`struct@ConverterOutputStream`] methods.
///
/// # Implementors
///
/// [`ConverterOutputStream`][struct@crate::ConverterOutputStream]
pub trait ConverterOutputStreamExt: IsA<ConverterOutputStream> + sealed::Sealed + 'static {
/// Gets the #GConverter that is used by @self.
///
/// # Returns
///
/// the converter of the converter output stream
#[doc(alias = "g_converter_output_stream_get_converter")]
#[doc(alias = "get_converter")]
fn converter(&self) -> Converter {
unsafe {
from_glib_none(ffi::g_converter_output_stream_get_converter(
self.as_ref().to_glib_none().0,
))
}
}
}
impl<O: IsA<ConverterOutputStream>> ConverterOutputStreamExt for O {}