mirror of
https://github.com/boostorg/iostreams.git
synced 2026-02-22 15:32:20 +00:00
219 lines
8.5 KiB
HTML
Executable File
219 lines
8.5 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Array Devices</TITLE>
|
|
<LINK REL='stylesheet' HREF='../../../../boost.css'>
|
|
<LINK REL='stylesheet' HREF='../theme/iostreams.css'>
|
|
</HEAD>
|
|
<BODY>
|
|
|
|
<!-- Begin Banner -->
|
|
|
|
<H1 CLASS='title'>Array Devices</H1>
|
|
<HR CLASS='banner'>
|
|
|
|
<!-- End Banner -->
|
|
|
|
<DL class='page-index'>
|
|
<DT><A href='#overview'>Overview</A></DT>
|
|
<DT><A href='#implementation'>Implementation</A></DT>
|
|
<DT><A href='#headers'>Headers</A></DT>
|
|
<DT><A href='#reference'>Reference</A>
|
|
<DL>
|
|
<DT><A href='#array_source'>Class template <CODE>array_source</CODE></A></DT>
|
|
<DT><A href='#array_sink'>Class template <CODE>array_sink</CODE></A></DT>
|
|
<DT><A href='#array'>Class template <CODE>array</CODE></A></DT>
|
|
</DL>
|
|
</DT>
|
|
<DT><A href='#acknowledgments'>Acknowledgments</A></DT>
|
|
</DL>
|
|
|
|
<HR>
|
|
|
|
<A NAME='overview'>
|
|
<H2>Overview</H2>
|
|
|
|
<P>
|
|
The classes <CODE>array_source</CODE>, <CODE>array_sink</CODE> and <CODE>array</CODE> provide access to a sequence of characters in memory. They array Devices do not manage the lifetimes of the underlying character sequences.
|
|
</P>
|
|
|
|
<A NAME='implementation'>
|
|
<H2>Implementation</H2>
|
|
|
|
<P>
|
|
The array Devices are implemented as <A HREF='../concepts/direct.html'>Direct</A> Devices in order to provide efficient unbuffered access to the underlying character sequences.
|
|
</P>
|
|
|
|
<A NAME='headers'>
|
|
<H2>Headers</H2>
|
|
|
|
<DL class='page-index'>
|
|
<DT><A CLASS='header' HREF='../../../../boost/iostreams/device/array.hpp'><CODE><boost/iostreams/device/array.hpp></CODE></A></DT>
|
|
</DL>
|
|
|
|
<A NAME='reference'>
|
|
<H2>Reference</H2>
|
|
|
|
<A NAME='array_source'>
|
|
<H3>Class template <CODE>array_source</CODE></H3>
|
|
|
|
<H4>Description</H4>
|
|
|
|
<P>Model of <A HREF='../concepts/source.html'>Source</A> providing read-only access to a sequence of characters in memory.</P>
|
|
|
|
<H4>Synopsis</H4>
|
|
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> <A CLASS="documented" HREF="#array_source_params">Ch</A>>
|
|
<SPAN CLASS="keyword">class</SPAN> <A CLASS="documented" HREF="#array_source_params">array_source</A> {
|
|
<SPAN CLASS="keyword">public</SPAN>:
|
|
<SPAN CLASS="keyword">typedef</SPAN> Ch char_type;
|
|
<SPAN CLASS="keyword">typedef</SPAN> source_tag io_category;
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> <A CLASS="documented" HREF="#array_source_constructors">array_source</A>(char_type (&)[N]);
|
|
<A CLASS="documented" HREF="#array_source_constructors">array_source</A>(char_type* begin, char_type* end);
|
|
<A CLASS="documented" HREF="#array_source_constructors">array_source</A>(char_type* begin, std::size_t length);
|
|
<A CLASS="documented" HREF="#array_source_constructors">array_source</A>(<SPAN CLASS="keyword">const</SPAN> char_type* begin, <SPAN CLASS="keyword">const</SPAN> char_type* end);
|
|
<A CLASS="documented" HREF="#array_source_constructors">array_source</A>(<SPAN CLASS="keyword">const</SPAN> char_type* begin, std::size_t length);
|
|
<SPAN CLASS='omitted'>...</SPAN>
|
|
};
|
|
|
|
} } // End namespace boost::io</PRE>
|
|
|
|
<A NAME='array_source_params'></A>
|
|
<H4>Template parameters</H4>
|
|
|
|
<TABLE STYLE='margin-left:2em'>
|
|
<TR>
|
|
<TD><I>Ch</I></TD><TD VALIGN='top'>-</TD>
|
|
<TD>The character type.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME='array_source_constructors'></A>
|
|
<H4><CODE>array_source::array_source</CODE></H4>
|
|
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> array_source(char_type (&)[N]);
|
|
array_source(char_type* begin, char_type* end);
|
|
array_source(char_type* begin, std::size_t length);
|
|
array_source(<SPAN CLASS="keyword">const</SPAN> char_type* begin, <SPAN CLASS="keyword">const</SPAN> char_type* end);
|
|
array_source(<SPAN CLASS="keyword">const</SPAN> char_type* begin, std::size_t length);</PRE>
|
|
|
|
<P>Constructs an <CODE>array_source</CODE> to read from the indicated character sequence.</P>
|
|
|
|
<A NAME='array_sink'>
|
|
<H3>Class template <CODE>array_sink</CODE></H3>
|
|
|
|
<H4>Description</H4>
|
|
|
|
<P>Model of <A HREF='../concepts/sink.html'>Sink</A> providing write-only access to a sequence of characters in memory.
|
|
|
|
<H4>Synopsis</H4>
|
|
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> <A CLASS="documented" HREF="#array_sink_params">Ch</A>>
|
|
<SPAN CLASS="keyword">class</SPAN> <A CLASS="documented" HREF="#array_sink_params">array_sink</A> {
|
|
<SPAN CLASS="keyword">public</SPAN>:
|
|
<SPAN CLASS="keyword">typedef</SPAN> Ch char_type;
|
|
<SPAN CLASS="keyword">typedef</SPAN> sink_tag io_category;
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> <A CLASS="documented" HREF="#array_sink_constructors">array_sink</A>(char_type (&)[N]);
|
|
<A CLASS="documented" HREF="#array_sink_constructors">array_sink</A>(char_type* begin, char_type* end);
|
|
<A CLASS="documented" HREF="#array_sink_constructors">array_sink</A>(char_type* begin, std::size_t length);
|
|
|
|
<SPAN CLASS="comment">// Additional nember functions</SPAN>
|
|
};
|
|
|
|
} } // End namespace boost::io</PRE>
|
|
|
|
<A NAME='array_sink_params'></A>
|
|
<H4>Template parameters</H4>
|
|
|
|
<TABLE STYLE='margin-left:2em'>
|
|
<TR>
|
|
<TD><I>Ch</I></TD><TD VALIGN='top'>-</TD>
|
|
<TD>The character type.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME='array_sink_constructors'></A>
|
|
<H4><CODE>array_sink::array_sink</CODE></H4>
|
|
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> array_sink(char_type (&)[N]);
|
|
array_sink(char_type* begin, char_type* end);
|
|
array_sink(char_type* begin, std::size_t length);</PRE>
|
|
|
|
<P>Constructs an <CODE>array_sink</CODE> to write to the indicated character sequence.</P>
|
|
|
|
<A NAME='array'>
|
|
<H3>Class template <CODE>array</CODE></H3>
|
|
|
|
<H4>Description</H4>
|
|
|
|
<P>Model of <A HREF='../concepts/seekable_device.html'>SeekableDevice</A> providing read-write access to a sequence of characters in memory.
|
|
|
|
<H4>Synopsis</H4>
|
|
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> <A CLASS="documented" HREF="#array_params">Ch</A>>
|
|
<SPAN CLASS="keyword">class</SPAN> <A CLASS="documented" HREF="#array_params">array</A> {
|
|
<SPAN CLASS="keyword">public</SPAN>:
|
|
<SPAN CLASS="keyword">typedef</SPAN> Ch char_type;
|
|
<SPAN CLASS="keyword">typedef</SPAN> seekable_device_tag io_category;
|
|
|
|
<SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> <A CLASS="documented" HREF="#array_constructor">array</A>(char_type (&)[N]);
|
|
<A CLASS="documented" HREF="#array_constructor">array</A>(char_type* begin, char_type* end);
|
|
<A CLASS="documented" HREF="#array_constructor">array</A>(char_type* begin, std::size_t length);
|
|
|
|
<SPAN CLASS="comment">// Additional nember functions</SPAN>
|
|
};
|
|
|
|
} } // End namespace boost::io</PRE>
|
|
|
|
<A NAME='array_params'></A>
|
|
<H4>Template parameters</H4>
|
|
|
|
<TABLE STYLE='margin-left:2em'>
|
|
<TR>
|
|
<TD><I>Ch</I></TD><TD VALIGN='top'>-</TD>
|
|
<TD>The character type.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME='array_constructor'></A>
|
|
<H4><CODE>array::array</CODE></H4>
|
|
|
|
<A NAME='array_constructor'>
|
|
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">int</SPAN> N> array(char_type (&)[N]);
|
|
array(char_type* begin, char_type* end);
|
|
array(char_type* begin, std::size_t length);</PRE>
|
|
|
|
<P>Constructs an <CODE>array</CODE> to access the indicated character sequence.</P>
|
|
|
|
<A NAME='acknowledgments'>
|
|
<H2>Acknowledgments</H2>
|
|
|
|
<P>
|
|
The concept of Devices which provide unbuffered access to character sequences was suggested by <A HREF="http://www.boost.org/people/daryle_walker.html">Daryle Walker's</A> <A HREF='http://cvs.sourceforge.net/viewcvs.py/boost-sandbox/boost-sandbox/libs/io/doc/array_stream.html'>array_stream</A> template.
|
|
</P>
|
|
|
|
<!-- Begin Footer -->
|
|
|
|
<HR>
|
|
<P CLASS='copyright'>Revised
|
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
20 May, 2004
|
|
<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
|
|
</P>
|
|
|
|
<P CLASS='copyright'>© Copyright Jonathan Turkanis, 2004</P>
|
|
<P CLASS='copyright'>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <A HREF='http://www.boost.org/LICENSE_1_0.txt'>http://www.boost.org/LICENSE_1_0.txt</A>)
|
|
</P>
|
|
|
|
<!-- End Footer -->
|
|
|
|
</BODY> |