gio/auto/
converter.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
// 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;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// `GConverter` is an interface for streaming conversions.
    ///
    /// `GConverter` is implemented by objects that convert
    /// binary data in various ways. The conversion can be
    /// stateful and may fail at any place.
    ///
    /// Some example conversions are: character set conversion,
    /// compression, decompression and regular expression
    /// replace.
    ///
    /// # Implements
    ///
    /// [`ConverterExt`][trait@crate::prelude::ConverterExt], [`ConverterExtManual`][trait@crate::prelude::ConverterExtManual]
    #[doc(alias = "GConverter")]
    pub struct Converter(Interface<ffi::GConverter, ffi::GConverterIface>);

    match fn {
        type_ => || ffi::g_converter_get_type(),
    }
}

impl Converter {
    pub const NONE: Option<&'static Converter> = None;
}

/// Trait containing all [`struct@Converter`] methods.
///
/// # Implementors
///
/// [`CharsetConverter`][struct@crate::CharsetConverter], [`Converter`][struct@crate::Converter], [`ZlibCompressor`][struct@crate::ZlibCompressor], [`ZlibDecompressor`][struct@crate::ZlibDecompressor]
pub trait ConverterExt: IsA<Converter> + 'static {
    /// Applies @self to the data in @bytes.
    /// ## `bytes`
    /// the data to convert
    ///
    /// # Returns
    ///
    /// A newly-allocated
    ///   `GBytes` with the converted data, or `NULL` if an error
    ///   occurred
    #[cfg(feature = "v2_82")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v2_82")))]
    #[doc(alias = "g_converter_convert_bytes")]
    fn convert_bytes(&self, bytes: &glib::Bytes) -> Result<glib::Bytes, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_converter_convert_bytes(
                self.as_ref().to_glib_none().0,
                bytes.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Resets all internal state in the converter, making it behave
    /// as if it was just created. If the converter has any internal
    /// state that would produce output then that output is lost.
    #[doc(alias = "g_converter_reset")]
    fn reset(&self) {
        unsafe {
            ffi::g_converter_reset(self.as_ref().to_glib_none().0);
        }
    }
}

impl<O: IsA<Converter>> ConverterExt for O {}