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
|
<?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-giomemoryinputstream">
<refnamediv>
<refname>gio.MemoryInputStream</refname>
<refpurpose>Base class for implementing streaming input</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.MemoryInputStream</classname></ooclass>
<ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-giomemoryinputstream">gio.MemoryInputStream</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giomemoryinputstream--add-data">add_data</link></methodname>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gio--memory-input-stream-new-from-data">gio.memory_input_stream_new_from_data</link></methodname>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gioinputstream">gio.InputStream</link>
+-- <link linkend="class-giomemoryinputstream">gio.MemoryInputStream</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
implements
<link linkend="class-gioseekable"><classname>gio.Seekable</classname></link>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
is a class for using arbitrary memory chunks as input for GIO streaming input operations.
</para>
</refsect1>
<refsect1 id="constructor-giomemoryinputstream">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.MemoryInputStream</methodname>
<methodparam><parameter role="keyword">icon</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates an empty
<link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giomemoryinputstream--add-data">
<title>gio.MemoryInputStream.add_data</title>
<programlisting><methodsynopsis language="python">
<methodname>add_data</methodname>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>input data.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>add_data</methodname>() method appends data to data
that can be read from the input stream
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gio--memory-input-stream-new-from-data">
<title>gio.memory_input_stream_new_from_data</title>
<programlisting><methodsynopsis language="python">
<methodname>memory_input_stream_new_from_data</methodname>
<methodparam><parameter role="keyword">data</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>data</parameter> :</term>
<listitem><simpara>input data.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A new
<link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
read from data
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>memory_input_stream_new_from_data</methodname>() function creates
a new <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
with data in memory.
</para>
</refsect2>
</refsect1>
</refentry>
|