gdk4/auto/
content_serializer.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
// 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::translate::*;

glib::wrapper! {
    /// A [`ContentSerializer`][crate::ContentSerializer] is used to serialize content for
    /// inter-application data transfers.
    ///
    /// The [`ContentSerializer`][crate::ContentSerializer] transforms an object that is identified
    /// by a GType into a serialized form (i.e. a byte stream) that is
    /// identified by a mime type.
    ///
    /// GTK provides serializers and deserializers for common data types
    /// such as text, colors, images or file lists. To register your own
    /// serialization functions, use [`content_register_serializer()`][crate::content_register_serializer()].
    ///
    /// Also see [`ContentDeserializer`][crate::ContentDeserializer].
    #[doc(alias = "GdkContentSerializer")]
    pub struct ContentSerializer(Object<ffi::GdkContentSerializer>);

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

impl ContentSerializer {
    /// Gets the cancellable for the current operation.
    ///
    /// This is the `GCancellable` that was passed to [`content_serialize_async()`][crate::content_serialize_async()].
    ///
    /// # Returns
    ///
    /// the cancellable for the current operation
    #[doc(alias = "gdk_content_serializer_get_cancellable")]
    #[doc(alias = "get_cancellable")]
    pub fn cancellable(&self) -> Option<gio::Cancellable> {
        unsafe {
            from_glib_none(ffi::gdk_content_serializer_get_cancellable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the `GType` to of the object to serialize.
    ///
    /// # Returns
    ///
    /// the `GType` for the current operation
    #[doc(alias = "gdk_content_serializer_get_gtype")]
    #[doc(alias = "get_gtype")]
    pub fn type_(&self) -> glib::types::Type {
        unsafe { from_glib(ffi::gdk_content_serializer_get_gtype(self.to_glib_none().0)) }
    }

    /// Gets the mime type to serialize to.
    ///
    /// # Returns
    ///
    /// the mime type for the current operation
    #[doc(alias = "gdk_content_serializer_get_mime_type")]
    #[doc(alias = "get_mime_type")]
    pub fn mime_type(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gdk_content_serializer_get_mime_type(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the output stream for the current operation.
    ///
    /// This is the stream that was passed to [`content_serialize_async()`][crate::content_serialize_async()].
    ///
    /// # Returns
    ///
    /// the output stream for the current operation
    #[doc(alias = "gdk_content_serializer_get_output_stream")]
    #[doc(alias = "get_output_stream")]
    pub fn output_stream(&self) -> gio::OutputStream {
        unsafe {
            from_glib_none(ffi::gdk_content_serializer_get_output_stream(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the `GValue` to read the object to serialize from.
    ///
    /// # Returns
    ///
    /// the `GValue` for the current operation
    #[doc(alias = "gdk_content_serializer_get_value")]
    #[doc(alias = "get_value")]
    pub fn value(&self) -> glib::Value {
        unsafe { from_glib_none(ffi::gdk_content_serializer_get_value(self.to_glib_none().0)) }
    }

    /// Indicate that the serialization has been successfully completed.
    #[doc(alias = "gdk_content_serializer_return_success")]
    pub fn return_success(&self) {
        unsafe {
            ffi::gdk_content_serializer_return_success(self.to_glib_none().0);
        }
    }
}