Function Template adapt

Overview

Headers

Reference

The overloaded function template adapt takes an OutputIterator, a pair of ForwardIterators or a standard i/o stream or stream buffer and returns a Device.^[1] Certain properties of the returned Device, including its i/o mode, are left indeterminate until the Device is added to a filtering_streambuf or filtering_stream. This is for two reasons:

• Certain information — such as the character type associated with an OutputIterator and the readability/writability of an iterator range — is not available at the type adapt is invoked.
• The i/o mode assigned by default to a standard i/o stream or stream buffer may not be what the library user desires. For instance, stream buffers by default are assumed to have mode Seekable; a particular stream buffer, however, might actually have mode Bidirectional, Bidirectional-Seekable or Dual-Seekable. Using adapt allows a standard i/o stream or stream buffer to be added to a filtering_streambuf or filtering_stream regardless of the latter's mode.

See STL Sequence Adapters for usage examples.

<boost/iostreams/adapt.hpp>

namespace boost { namespace iostreams {
              
    template<typename OutIt>
    implementation-defined adapt(const OutIt& out);
    
    template<typename FwdIt>
    implementation-defined adapt(FwdIt first, FwdIt last);
    
    template<typename Ch, typename Tr>
    implementation-defined adapt(std::basic_iostream<Ch, Tr>& io);
    
    template<typename Ch, typename Tr>
    implementation-defined adapt(std::basic_streambuf<Ch, Tr>& sb);

} } // End namespace boost::io

    template<typename OutIt>
    implementation-defined adapt(const OutIt& out);

Template Parameters

Return Value

Returns a Sink for writing to the sequence controlled by out.^[1]

    template<typename FwdIt>
    implementation-defined adapt(FwdIt first, FwdIt last);

Template Parameters

Return Value

Returns a Device for accessing the sequence delimited by first and last.^[1] The i/o mode of the Device is determined at the time it is added to a filtering_streambuf or filtering_stream.

    template<typename Ch, typename Tr>
    implementation-defined adapt(std::basic_iostream<Ch, Tr>& io);
    
    template<typename Ch, typename Tr>
    implementation-defined adapt(std::basic_streambuf<Ch, Tr>& sb);

Template Parameters

Return Value

Returns a Device for accessing the sequence or sequences controlled by the given i/o stream or stream buffer.^[1] The i/o mode of the Device is determined at the time it is added to a filtering_streambuf or filtering_stream.

^[1]Striclty speaking, the object returned is not a true Device, since its i/o mode and possibly its character type are indeterminate. It is better termed a pseudo Device.

Revised 20 May, 2004

© Copyright Jonathan Turkanis, 2004

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)