<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
  "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<!--
  Hamigaki.Iostreams Library Document Source

  Copyright Takeshi Mouri 2006, 2007.
  Distributed under the Boost Software License, Version 1.0.
  (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt)

  See http://hamigaki.sourceforge.jp/libs/iostreams for library home page.
-->
<header name="hamigaki/iostreams/lazy_restrict.hpp">
  <namespace name="hamigaki">
    <namespace name="iostreams">
      <class name="lazy_restriction">
        <template>
          <template-type-parameter name="Device"/>
        </template>

        <description>
          <para><code>lazy_restriction</code>は<code>boost::iostreams::restriction</code>の変種である。<code>restriction</code>との違いは、<itemizedlist>
              <listitem><para>オフセットの基準はストリームの先頭である</para></listitem>
              <listitem><para>オフセット位置へのシークは、実際にストリームにアクセスするまで遅延される</para></listitem>
              <listitem><para>ストリームのコピーを行わず、ポインタを保持する</para></listitem>
            </itemizedlist>である。</para>
          <para>モデルとなるコンセプト:<simplelist type='inline'>
              <member><conceptname>SeekableSource</conceptname>(<code>Device</code>が<conceptname>SeekableSource</conceptname>である場合)</member>
              <member><conceptname>SeekableSink</conceptname>(<code>Device</code>が<conceptname>SeekableSink</conceptname>である場合)</member>
          </simplelist></para>
        </description>

        <typedef name="char_type">
          <type>boost::iostreams::char_type_of&lt;Device&gt;::type</type>
        </typedef>

        <constructor>
          <parameter name="dev">
            <paramtype>Device&amp;</paramtype>
          </parameter>
          <parameter name="off">
            <paramtype>boost::iostreams::stream_offset</paramtype>
          </parameter>
          <parameter name="len">
            <paramtype>boost::iostreams::stream_offset</paramtype>
            <default>-1</default>
          </parameter>
        </constructor>

        <method-group name="Boost.Iostreams implementation">
          <method name="read">
            <type>std::streamsize</type>
            <parameter name="s">
              <paramtype>char_type*</paramtype>
            </parameter>
            <parameter name="n">
              <paramtype>std::streamsize</paramtype>
            </parameter>
          </method>

          <method name="write">
            <type>std::streamsize</type>
            <parameter name="s">
              <paramtype>const char_type*</paramtype>
            </parameter>
            <parameter name="n">
              <paramtype>std::streamsize</paramtype>
            </parameter>
          </method>

          <method name="seek">
            <type>std::streampos</type>
            <parameter name="off">
              <paramtype>boost::iostreams::stream_offset</paramtype>
            </parameter>
            <parameter name="way">
              <paramtype>std::ios_base::seekdir</paramtype>
            </parameter>
          </method>
        </method-group>

        <free-function-group name="creation">
          <function name="lazy_restrict">
            <type>lazy_restriction&lt;Device&gt;</type>
            <template>
              <template-type-parameter name="Device"/>
            </template>
            <parameter name="dev">
              <paramtype>Device&amp;</paramtype>
            </parameter>
            <parameter name="off">
              <paramtype>boost::iostreams::stream_offset</paramtype>
            </parameter>
            <parameter name="len">
              <paramtype>boost::iostreams::stream_offset</paramtype>
              <default>-1</default>
            </parameter>
            <returns><simpara><code><classname>lazy_restriction</classname>&lt;Device&gt;(dev, off, len)</code></simpara></returns>
          </function>
        </free-function-group>
      </class>
    </namespace>
  </namespace>
</header>
