forked from boostorg/beast
Vinnie Falco
bef9ae11ea
A new function, buffers(), returns an implementation defined object
which wraps a ConstBufferSequence and supports formatting to a
std::ostream.
The function to_string is removed, as the new implementation allows
conversion to string using boost::lexical_cast on the return value
of the call to buffers(). Streaming to an output stream is more
efficient: no dynamic allocations are performed.
Example:
streambuf sb;
std::cout << buffers(sb.data()) << std::endl;
101 lines
3.0 KiB
C++
101 lines
3.0 KiB
C++
//
|
|
// Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
|
|
//
|
|
// 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)
|
|
//
|
|
|
|
#ifndef BEAST_WRITE_OSTREAM_HPP
|
|
#define BEAST_WRITE_OSTREAM_HPP
|
|
|
|
#include <beast/config.hpp>
|
|
#include <beast/core/buffer_concepts.hpp>
|
|
#include <beast/core/detail/ostream.hpp>
|
|
#include <type_traits>
|
|
#include <streambuf>
|
|
#include <utility>
|
|
|
|
namespace beast {
|
|
|
|
/** Return an object representing a @b ConstBufferSequence.
|
|
|
|
This function wraps a reference to a buffer sequence and permits
|
|
the following operation:
|
|
|
|
@li `operator<<` to `std::ostream`. No character translation is
|
|
performed; unprintable and null characters will be transferred
|
|
as-is to the output stream.
|
|
|
|
@par Example
|
|
@code
|
|
streambuf sb;
|
|
...
|
|
std::cout << buffers(sb.data()) << std::endl;
|
|
@endcode
|
|
|
|
@param b An object meeting the requirements of @b ConstBufferSequence
|
|
to be streamed. The implementation will make a copy of this object.
|
|
*/
|
|
template<class ConstBufferSequence>
|
|
#if BEAST_DOXYGEN
|
|
implementation_defined
|
|
#else
|
|
detail::buffers_helper<ConstBufferSequence>
|
|
#endif
|
|
buffers(ConstBufferSequence const& b)
|
|
{
|
|
static_assert(is_ConstBufferSequence<
|
|
ConstBufferSequence>::value,
|
|
"ConstBufferSequence not met");
|
|
return detail::buffers_helper<
|
|
ConstBufferSequence>{b};
|
|
}
|
|
|
|
/** Return an output stream that formats values into a @b DynamicBuffer.
|
|
|
|
This function wraps the caller provided @b DynamicBuffer into
|
|
a `std::ostream` derived class, to allow `operator<<` stream style
|
|
formatting operations.
|
|
|
|
@par Example
|
|
@code
|
|
ostream(buffer) << "Hello, world!" << std::endl;
|
|
@endcode
|
|
|
|
@note Calling members of the underlying buffer before the output
|
|
stream is destroyed results in undefined behavior.
|
|
|
|
@param buffer An object meeting the requirements of @b DynamicBuffer
|
|
into which the formatted output will be placed.
|
|
|
|
@return An object derived from `std::ostream` which directs output
|
|
into the specified dynamic buffer. Ownership of the dynamic buffer
|
|
is not transferred. The caller is responsible for ensuring the
|
|
dynamic buffer is not destroyed for the lifetime of the output
|
|
stream.
|
|
*/
|
|
template<class DynamicBuffer>
|
|
#if BEAST_DOXYGEN
|
|
implementation_defined
|
|
#else
|
|
detail::ostream_helper<
|
|
DynamicBuffer, char, std::char_traits<char>,
|
|
std::is_move_constructible<
|
|
detail::ostream_buffer<DynamicBuffer,
|
|
char, std::char_traits<char>>>::value>
|
|
#endif
|
|
ostream(DynamicBuffer& buffer)
|
|
{
|
|
static_assert(is_DynamicBuffer<DynamicBuffer>::value,
|
|
"DynamicBuffer requirements not met");
|
|
return detail::ostream_helper<
|
|
DynamicBuffer, char, std::char_traits<char>,
|
|
std::is_move_constructible<
|
|
detail::ostream_buffer<DynamicBuffer,
|
|
char, std::char_traits<char>>>::value>{buffer};
|
|
}
|
|
|
|
} // beast
|
|
|
|
#endif
|