feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity
Files
991bae8486b3a564c6444b9a156979ef704d0840
boost_beast/include/boost/beast/core/ostream.hpp

105 lines
3.2 KiB
C++
Raw Normal View History

New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
//
Update copyrights
2017-07-24 09:42:36 -07:00
// Copyright (c) 2016-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
//
// 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)
//
Boost prep
2017-07-20 13:40:34 -07:00
// Official repository: https://github.com/boostorg/beast
//
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
Boost prep
2017-07-20 13:40:34 -07:00
#ifndef BOOST_BEAST_WRITE_OSTREAM_HPP
#define BOOST_BEAST_WRITE_OSTREAM_HPP
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
config.hpp is not a public header
2017-10-10 07:49:03 -07:00
#include <boost/beast/core/detail/config.hpp>
Boost prep
2017-07-20 13:40:34 -07:00
#include <boost/beast/core/type_traits.hpp>
#include <boost/beast/core/detail/ostream.hpp>
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
#include <type_traits>
#include <streambuf>
#include <utility>
Boost prep
2017-07-20 13:40:34 -07:00
namespace boost {
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
namespace beast {
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
/** 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
Rename to multi_buffer, basic_multi_buffer (API Change): These classes are renamed: * streambuf to multi_buffer * basic_streambuf to basic_multi_buffer
2017-05-04 15:40:07 -07:00
multi_buffer b;
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
...
Rename to multi_buffer, basic_multi_buffer (API Change): These classes are renamed: * streambuf to multi_buffer * basic_streambuf to basic_multi_buffer
2017-05-04 15:40:07 -07:00
std::cout << buffers(b.data()) << std::endl;
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
@endcode
@param b An object meeting the requirements of @b ConstBufferSequence
to be streamed. The implementation will make a copy of this object.
Concept revision and documentation (API Change): The concept type traits are renamed for consistency, and consolidated into a single header file <beast/core/type_traits.hpp> A new section, Core Concepts, is added to the documentation describing all of the core utility classes and functions. This also includes a complete explanation and sample program describing how to write asynchronous initiation functions and their associated composed operations.
2017-05-10 12:03:00 -07:00
Ownership of the underlying memory is not transferred, the application
is still responsible for managing its lifetime.
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
*/
template<class ConstBufferSequence>
Boost prep
2017-07-20 13:40:34 -07:00
#if BOOST_BEAST_DOXYGEN
Squashed 'doc/docca/' changes from 1bfc5ede..df9bd956 df9bd956 Add deduced alias 220ded9a Add see-below alias git-subtree-dir: doc/docca git-subtree-split: df9bd956e2480467447c80ffae3b44b3c0b0756a
2018-11-11 21:53:13 -08:00
__implementation_defined__
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
#else
detail::buffers_helper<ConstBufferSequence>
#endif
buffers(ConstBufferSequence const& b)
{
net is a namespace alias for boost::asio: The namespace alias beast::net replaces boost::asio in all code and documentation.
2018-11-30 14:58:38 -08:00
static_assert(net::is_const_buffer_sequence<
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
ConstBufferSequence>::value,
Add HEAD request example
2017-06-04 07:49:38 -07:00
"ConstBufferSequence requirements not met");
New buffers() replaces to_string() (API Change): 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;
2017-05-04 05:01:50 -07:00
return detail::buffers_helper<
ConstBufferSequence>{b};
}
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
/** 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.
Concept revision and documentation (API Change): The concept type traits are renamed for consistency, and consolidated into a single header file <beast/core/type_traits.hpp> A new section, Core Concepts, is added to the documentation describing all of the core utility classes and functions. This also includes a complete explanation and sample program describing how to write asynchronous initiation functions and their associated composed operations.
2017-05-10 12:03:00 -07:00
@return An object derived from `std::ostream` which redirects output
The wrapped dynamic buffer is not modified, a copy is made instead.
Ownership of the underlying memory is not transferred, the application
is still responsible for managing its lifetime. The caller is
responsible for ensuring the dynamic buffer is not destroyed for the
lifetime of the output stream.
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
*/
template<class DynamicBuffer>
Boost prep
2017-07-20 13:40:34 -07:00
#if BOOST_BEAST_DOXYGEN
Squashed 'doc/docca/' changes from 1bfc5ede..df9bd956 df9bd956 Add deduced alias 220ded9a Add see-below alias git-subtree-dir: doc/docca git-subtree-split: df9bd956e2480467447c80ffae3b44b3c0b0756a
2018-11-11 21:53:13 -08:00
__implementation_defined__
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
#else
detail::ostream_helper<
DynamicBuffer, char, std::char_traits<char>,
ostream workaround for gcc 4.8.4
2017-05-08 19:02:58 -07:00
detail::basic_streambuf_movable::value>
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
#endif
ostream(DynamicBuffer& buffer)
{
Update for Net-TS Asio (API Change): fix #769 The following classes are removed: * handler_type * async_result * async_completion * is_dynamic_buffer * is_const_buffer_sequence * is_mutable_buffer_sequence * handler_alloc Actions Required: * Use BOOST_ASIO_HANDLER_TYPE instead of handler_type * Use BOOST_ASIO_INITFN_RESULT_TYPE instead of async_result * Use boost::asio::async_completion * Use boost::asio::is_dynamic_buffer * Use boost::asio::is_const_buffer_sequence * Use boost::asio::is_mutable_buffer_sequence * boost::asio::associated_allocator_t replaces handler_alloc
2017-09-07 07:39:52 -07:00
static_assert(
net is a namespace alias for boost::asio: The namespace alias beast::net replaces boost::asio in all code and documentation.
2018-11-30 14:58:38 -08:00
net::is_dynamic_buffer<DynamicBuffer>::value,
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
"DynamicBuffer requirements not met");
return detail::ostream_helper<
DynamicBuffer, char, std::char_traits<char>,
ostream workaround for gcc 4.8.4
2017-05-08 19:02:58 -07:00
detail::basic_streambuf_movable::value>{buffer};
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
}
} // beast
Boost prep
2017-07-20 13:40:34 -07:00
} // boost
New ostream() returns dynamic buffer output stream (API Change): This eliminates beast::write output for dynamic buffers and replaces it with the function ostream() that wraps a caller provided dynamic buffer and returns the result as a std::ostream derived object. Callers may now produce formatted output into any object meeting the requirements of DynamicBuffer using operator<< and the standard stream modifiers such as std::endl. This new technique is more efficient, as implementations of operator<< can now write directly into the output using std::ostream::write and std::ostream::put. Example of use: beast::streambuf sb; beast::ostream(sb) << "Hello, world!" << std::endl;
2017-05-03 15:29:23 -07:00
#endif
Copy Permalink