docs/reference/pygio-memoryinputstream.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3     "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="class-giomemoryinputstream">
   6     <refnamediv>
   7         <refname>gio.MemoryInputStream</refname>
   8         <refpurpose>Base class for implementing streaming input</refpurpose>
   9     </refnamediv>
  10
  11     <refsect1>
  12         <title>Synopsis</title>
  13
  14     <classsynopsis language="python">
  15         <ooclass><classname>gio.MemoryInputStream</classname></ooclass>
  16         <ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
  17
  18     <constructorsynopsis language="python">
  19         <methodname><link linkend="constructor-giomemoryinputstream">gio.MemoryInputStream</link></methodname>
  20         <methodparam></methodparam>
  21     </constructorsynopsis>
  22
  23
  24     <methodsynopsis language="python">
  25         <methodname><link linkend="method-giomemoryinputstream--add-data">add_data</link></methodname>
  26         <methodparam><parameter role="keyword">data</parameter></methodparam>
  27     </methodsynopsis>
  28
  29     </classsynopsis>
  30
  31 <programlisting>
  32 <emphasis role="bold">Functions</emphasis>
  33
  34 <methodsynopsis language="python">
  35     <methodname><link linkend="function-gio--memory-input-stream-new-from-data">gio.memory_input_stream_new_from_data</link></methodname>
  36     <methodparam><parameter role="keyword">data</parameter></methodparam>
  37 </methodsynopsis></programlisting>
  38
  39     </refsect1>
  40
  41     <refsect1>
  42         <title>Ancestry</title>
  43
  44 <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  45   +-- <link linkend="class-gioinputstream">gio.InputStream</link>
  46     +-- <link linkend="class-giomemoryinputstream">gio.MemoryInputStream</link>
  47 </synopsis>
  48
  49     </refsect1>
  50
  51     <refsect1>
  52         <title>Implemented Interfaces</title>
  53         <para>
  54             <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
  55             implements
  56             <link linkend="class-gioseekable"><classname>gio.Seekable</classname></link>
  57         </para>
  58     </refsect1>
  59
  60     <refsect1>
  61         <title>Description</title>
  62
  63         <para>
  64             <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
  65             is a class for using arbitrary memory chunks as input for GIO streaming input operations.
  66         </para>
  67     </refsect1>
  68
  69     <refsect1 id="constructor-giomemoryinputstream">
  70         <title>Constructor</title>
  71
  72         <programlisting><constructorsynopsis language="python">
  73             <methodname>gio.MemoryInputStream</methodname>
  74             <methodparam><parameter role="keyword">icon</parameter></methodparam>
  75         </constructorsynopsis></programlisting>
  76         <variablelist>
  77             <varlistentry>
  78                 <term><emphasis>Returns</emphasis>&nbsp;:</term>
  79                 <listitem><simpara>a new
  80                 <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
  81                 </simpara></listitem>
  82             </varlistentry>
  83         </variablelist>
  84
  85         <para>
  86             Creates an empty
  87             <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
  88         </para>
  89
  90     </refsect1>
  91
  92     <refsect1>
  93         <title>Methods</title>
  94
  95         <refsect2 id="method-giomemoryinputstream--add-data">
  96             <title>gio.MemoryInputStream.add_data</title>
  97
  98             <programlisting><methodsynopsis language="python">
  99                 <methodname>add_data</methodname>
 100                 <methodparam><parameter role="keyword">data</parameter></methodparam>
 101             </methodsynopsis></programlisting>
 102
 103             <variablelist>
 104                 <varlistentry>
 105                   <term><parameter role="keyword">data</parameter>&nbsp;:</term>
 106                   <listitem><simpara>input data.
 107                   </simpara></listitem>
 108                 </varlistentry>
 109             </variablelist>
 110
 111             <para>
 112                 The <methodname>add_data</methodname>() method appends data to data
 113                 that can be read from the input stream
 114             </para>
 115         </refsect2>
 116     </refsect1>
 117
 118     <refsect1>
 119         <title>Functions</title>
 120
 121         <refsect2 id="function-gio--memory-input-stream-new-from-data">
 122             <title>gio.memory_input_stream_new_from_data</title>
 123
 124             <programlisting><methodsynopsis language="python">
 125                 <methodname>memory_input_stream_new_from_data</methodname>
 126                 <methodparam><parameter role="keyword">data</parameter></methodparam>
 127             </methodsynopsis></programlisting>
 128
 129             <variablelist>
 130                 <varlistentry>
 131                     <term><parameter>data</parameter>&nbsp;:</term>
 132                     <listitem><simpara>input data.
 133                     </simpara></listitem>
 134                 </varlistentry>
 135                 <varlistentry>
 136                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 137                     <listitem><simpara>A new
 138                     <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
 139                     read from data
 140                     </simpara></listitem>
 141                 </varlistentry>
 142             </variablelist>
 143
 144             <para>
 145                 The <methodname>memory_input_stream_new_from_data</methodname>() function creates
 146                 a new <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
 147                 with data in memory.
 148             </para>
 149         </refsect2>
 150     </refsect1>
 151 </refentry>