blob: f0444965a8c698f125cd2ef4daf5e05f80a60f0c (
plain)
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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-giomemoryoutputstream">
<refnamediv>
<refname>gio.MemoryOutputStream</refname>
<refpurpose>Streaming output operations on memory chunks</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.MemoryOutputStream</classname></ooclass>
<ooclass><classname><link linkend="class-giooutputstream">gio.OutputStream</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-giomemoryoutputstream">gio.MemoryOutputStream</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giomemoryoutputstream--get-contents">get_contents</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giomemoryoutputstream--get-data-size">get_data_size</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giomemoryoutputstream--get-size">get_size</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-giooutputstream">gio.OutputStream</link>
+-- <link linkend="class-giomemoryoutputstream">gio.MemoryOutputStream</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-giomemoryoutputstream"><classname>gio.MemoryOutputStream</classname></link>
implements
<link linkend="class-gioseekable"><classname>gio.Seekable</classname></link>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-giomemoryoutputstream"><classname>gio.MemoryOutputStream</classname></link>
is a class for using arbitrary memory chunks as output for GIO streaming output operations.
</para>
</refsect1>
<refsect1 id="constructor-giomemoryoutputstream">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.MemoryOutputStream</methodname>
<methodparam></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-giomemoryoutputstream"><classname>gio.MemoryOutputStream</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new
<link linkend="class-giomemoryoutputstream"><classname>gio.MemoryOutputStream</classname></link>.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giomemoryoutputstream--get-contents">
<title>gio.MemoryOutputStream.get_contents</title>
<programlisting><methodsynopsis language="python">
<methodname>get_contents</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the stream's data
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_contents</methodname>() method gets any loaded data
from the ostream.
</para>
<para>
Note that the returned data may become invalid on the next write or truncate
operation on the stream.
</para>
</refsect2>
<refsect2 id="method-giomemoryoutputstream--get-data-size">
<title>gio.MemoryOutputStream.get_data_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_data_size</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of bytes written to the stream
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_data_size</methodname>() method returns the number
of bytes from the start up to including the last byte written in the
stream that has not been truncated away.
</para>
</refsect2>
<refsect2 id="method-giomemoryoutputstream--get-size">
<title>gio.MemoryOutputStream.get_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of bytes allocated for the data buffer
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_size</methodname>() method gets the size of the
currently allocated data area (availible from
<methodname><link linkend="method-giomemoryoutputstream--get-contents">gio.MemoryOutputStream.get_contents</link></methodname>()
).
</para>
<para>
Note that for growable streams the returned size may become invalid on the next write or truncate operation on the stream.
</para>
<para>
If you want the number of bytes currently written to the stream, use
<methodname><link linkend="method-giomemoryoutputstream--get-data-size">gio.MemoryOutputStream.get_data_size</link></methodname>().
</para>
</refsect2>
</refsect1>
</refentry>
|
