view release on metacpan or  search on metacpan

redland/raptor/docs/xml/section-iostream.xml  view on Meta::CPAN

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="raptor-section-iostream">
<refmeta>
<refentrytitle role="top_of_page">I/O Stream</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RAPTOR Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>I/O Stream</refname>
<refpurpose>Providing streaming I/O writing to files, strings or user code.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



typedef     <link linkend="raptor-iostream">raptor_iostream</link>;
<link linkend="int">int</link>         (<link linkend="raptor-iostream-init-func">*raptor_iostream_init_func</link>)    (<link linkend="void">void</link> *context);
<link linkend="void">void</link>        (<link linkend="raptor-iostream-finish-func">*raptor_iostream_finish_func</link>)  (<link linkend="void">void</link> *context);
<link linkend="int">int</link>         (<link linkend="raptor-iostream-write-byte-func">*raptor_iostream_write_byte_func</link>)
                                            (<link linkend="void">void</link> *context,
                                             const <link linkend="int">int</link> byte);
<link linkend="int">int</link>         (<link linkend="raptor-iostream-write-bytes-func">*raptor_iostream_write_bytes_func</link>)
                                            (<link linkend="void">void</link> *context,
                                             const <link linkend="void">void</link> *ptr,
                                             <link linkend="size-t">size_t</link> size,
                                             <link linkend="size-t">size_t</link> nmemb);
<link linkend="void">void</link>        (<link linkend="raptor-iostream-write-end-func">*raptor_iostream_write_end_func</link>)
                                            (<link linkend="void">void</link> *context);
            <link linkend="raptor-iostream-handler">raptor_iostream_handler</link>;
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-new-iostream-from-handler">raptor_new_iostream_from_handler</link>
                                            (<link linkend="void">void</link> *context,
                                             const <link linkend="raptor-iostream-handler">raptor_iostream_handler</link> *handler);
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-new-iostream-to-sink">raptor_new_iostream_to_sink</link>
                                            (void);
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-new-iostream-to-filename">raptor_new_iostream_to_filename</link>
                                            (const <link linkend="char">char</link> *filename);
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-new-iostream-to-file-handle">raptor_new_iostream_to_file_handle</link>
                                            (<link linkend="FILE:CAPS">FILE</link> *handle);
<link linkend="raptor-iostream">raptor_iostream</link>* <link linkend="raptor-new-iostream-to-string">raptor_new_iostream_to_string</link>
                                            (<link linkend="void">void</link> **string_p,
                                             <link linkend="size-t">size_t</link> *length_p,
                                             <link linkend="void">void</link>* (*malloc_handler) (size_t size));
<link linkend="void">void</link>        <link linkend="raptor-free-iostream">raptor_free_iostream</link>            (<link linkend="raptor-iostream">raptor_iostream</link> *iostr);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-bytes">raptor_iostream_write_bytes</link>     (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             const <link linkend="void">void</link> *ptr,
                                             <link linkend="size-t">size_t</link> size,
                                             <link linkend="size-t">size_t</link> nmemb);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-byte">raptor_iostream_write_byte</link>      (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             const <link linkend="int">int</link> byte);
<link linkend="void">void</link>        <link linkend="raptor-iostream-write-end">raptor_iostream_write_end</link>       (<link linkend="raptor-iostream">raptor_iostream</link> *iostr);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-string">raptor_iostream_write_string</link>    (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             const <link linkend="void">void</link> *string);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-counted-string">raptor_iostream_write_counted_string</link>
                                            (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             const <link linkend="void">void</link> *string,
                                             <link linkend="size-t">size_t</link> len);
<link linkend="size-t">size_t</link>      <link linkend="raptor-iostream-get-bytes-written-count">raptor_iostream_get_bytes_written_count</link>
                                            (<link linkend="raptor-iostream">raptor_iostream</link> *iostr);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-decimal">raptor_iostream_write_decimal</link>   (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             <link linkend="int">int</link> integer);
<link linkend="int">int</link>         <link linkend="raptor-iostream-format-hexadecimal">raptor_iostream_format_hexadecimal</link>
                                            (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
                                             unsigned <link linkend="int">int</link> integer,
                                             <link linkend="int">int</link> width);
<link linkend="int">int</link>         <link linkend="raptor-iostream-write-stringbuffer">raptor_iostream_write_stringbuffer</link>