From 982d20001f1d9efb7f8f151c755c148c407dd746 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Sat, 3 Jun 2017 07:10:11 -0700 Subject: [PATCH] Rename to buffer_cat_view (API Change) fix #408 --- CHANGELOG.md | 1 + doc/2_core.qbk | 21 +++++++------- doc/quickref.xml | 2 +- include/beast/core/buffer_cat.hpp | 20 +++++++------- include/beast/core/impl/buffer_cat.ipp | 38 +++++++++++++------------- include/beast/http/serializer.hpp | 8 +++--- test/core/consuming_buffers.cpp | 2 +- 7 files changed, 46 insertions(+), 46 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec837686..2bee5ba9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ Version 48 API Changes: * Tidy up chunk decorator +* Rename to buffer_cat_view -------------------------------------------------------------------------------- diff --git a/doc/2_core.qbk b/doc/2_core.qbk index 11b47205..4b18e7df 100644 --- a/doc/2_core.qbk +++ b/doc/2_core.qbk @@ -307,26 +307,25 @@ caller; ownership is not transferred. [[ [link beast.ref.buffer_cat `buffer_cat`] ][ - The functions returns a new buffer sequence which, when iterated, + This functions returns a new buffer sequence which, when iterated, traverses the sequence which would be formed if all of the input buffer - sequences were concatenated. This powerful function allows multiple calls - to a stream's `write_some` function to be combined into one, eliminating + sequences were concatenated. With this routine, multiple calls to a + stream's `write_some` function may be combined into one, eliminating expensive system calls. ]] [[ - [link beast.ref.buffer_prefix `buffer_prefix`] -][ - This function returns a new buffer or buffer sequence which wraps the - underlying memory of an existing buffer sequence, but with a smaller size. - This lets callers work with a prefix of a buffer sequence. -]] -[[ - [link beast.ref.buffer_cat `buffers_view`] + [link beast.ref.buffer_cat_view `buffer_cat_view`] ][ This class represents the buffer sequence formed by concatenating two or more buffer sequences. This is type of object returned by [link beast.ref.buffer_cat `buffer_cat`]. ]] +[[ + [link beast.ref.buffer_prefix `buffer_prefix`] +][ + This function returns a new buffer or buffer sequence which represents + a prefix of the original buffers. +]] [[ [link beast.ref.consuming_buffers `consuming_buffers`] ][ diff --git a/doc/quickref.xml b/doc/quickref.xml index bdff2bef..207e8074 100644 --- a/doc/quickref.xml +++ b/doc/quickref.xml @@ -167,8 +167,8 @@ basic_flat_buffer basic_multi_buffer buffers_adapter - buffers_view consuming_buffers + buffer_cat_view buffered_read_stream error_category error_code diff --git a/include/beast/core/buffer_cat.hpp b/include/beast/core/buffer_cat.hpp index 300d8c26..d9234c40 100644 --- a/include/beast/core/buffer_cat.hpp +++ b/include/beast/core/buffer_cat.hpp @@ -19,7 +19,7 @@ namespace beast { @see @ref buffer_cat */ template -class buffers_view +class buffer_cat_view { std::tuple bn_; @@ -41,16 +41,16 @@ public: class const_iterator; /// Move constructor - buffers_view(buffers_view&&) = default; + buffer_cat_view(buffer_cat_view&&) = default; /// Copy constructor - buffers_view(buffers_view const&) = default; + buffer_cat_view(buffer_cat_view const&) = default; /// Move assignment - buffers_view& operator=(buffers_view&&) = default; + buffer_cat_view& operator=(buffer_cat_view&&) = default; // Copy assignment - buffers_view& operator=(buffers_view const&) = default; + buffer_cat_view& operator=(buffer_cat_view const&) = default; /** Constructor @@ -59,7 +59,7 @@ public: of memory is not transferred. */ explicit - buffers_view(Buffers const&... buffers); + buffer_cat_view(Buffers const&... buffers); /// Return an iterator to the beginning of the concatenated sequence. const_iterator @@ -87,23 +87,23 @@ public: also a @b MutableBufferSequence; otherwise the returned buffer sequence will be a @b ConstBufferSequence. - @see @ref buffers_view + @see @ref buffer_cat_view */ #if BEAST_DOXYGEN template -buffers_view +buffer_cat_view buffer_cat(BufferSequence const&... buffers) #else template inline -buffers_view +buffer_cat_view buffer_cat(B1 const& b1, B2 const& b2, Bn const&... bn) #endif { static_assert( detail::is_all_const_buffer_sequence::value, "BufferSequence requirements not met"); - return buffers_view{b1, b2, bn...}; + return buffer_cat_view{b1, b2, bn...}; } } // beast diff --git a/include/beast/core/impl/buffer_cat.ipp b/include/beast/core/impl/buffer_cat.ipp index dd606a29..55e289a2 100644 --- a/include/beast/core/impl/buffer_cat.ipp +++ b/include/beast/core/impl/buffer_cat.ipp @@ -22,14 +22,14 @@ namespace beast { template -class buffers_view::const_iterator +class buffer_cat_view::const_iterator { std::size_t n_; std::tuple const* bn_; std::array()> buf_; - friend class buffers_view; + friend class buffer_cat_view; template using C = std::integral_constant; @@ -319,14 +319,14 @@ private: //------------------------------------------------------------------------------ template -buffers_view:: +buffer_cat_view:: const_iterator::~const_iterator() { destroy(C<0>{}); } template -buffers_view:: +buffer_cat_view:: const_iterator::const_iterator() : n_(sizeof...(Bn)) , bn_(nullptr) @@ -334,7 +334,7 @@ const_iterator::const_iterator() } template -buffers_view:: +buffer_cat_view:: const_iterator::const_iterator( std::tuple const& bn, bool at_end) : bn_(&bn) @@ -346,7 +346,7 @@ const_iterator::const_iterator( } template -buffers_view:: +buffer_cat_view:: const_iterator::const_iterator(const_iterator&& other) : n_(other.n_) , bn_(other.bn_) @@ -355,7 +355,7 @@ const_iterator::const_iterator(const_iterator&& other) } template -buffers_view:: +buffer_cat_view:: const_iterator::const_iterator(const_iterator const& other) : n_(other.n_) , bn_(other.bn_) @@ -365,7 +365,7 @@ const_iterator::const_iterator(const_iterator const& other) template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator=(const_iterator&& other) -> const_iterator& { @@ -381,7 +381,7 @@ const_iterator::operator=(const_iterator&& other) -> template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator=(const_iterator const& other) -> const_iterator& { @@ -397,7 +397,7 @@ const_iterator& template bool -buffers_view:: +buffer_cat_view:: const_iterator::operator==(const_iterator const& other) const { if(bn_ != other.bn_) @@ -409,7 +409,7 @@ const_iterator::operator==(const_iterator const& other) const template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator*() const -> reference { @@ -418,7 +418,7 @@ const_iterator::operator*() const -> template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator++() -> const_iterator& { @@ -428,7 +428,7 @@ const_iterator::operator++() -> template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator++(int) -> const_iterator { @@ -439,7 +439,7 @@ const_iterator::operator++(int) -> template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator--() -> const_iterator& { @@ -449,7 +449,7 @@ const_iterator::operator--() -> template auto -buffers_view:: +buffer_cat_view:: const_iterator::operator--(int) -> const_iterator { @@ -461,8 +461,8 @@ const_iterator::operator--(int) -> //------------------------------------------------------------------------------ template -buffers_view:: -buffers_view(Bn const&... bn) +buffer_cat_view:: +buffer_cat_view(Bn const&... bn) : bn_(bn...) { } @@ -471,7 +471,7 @@ buffers_view(Bn const&... bn) template inline auto -buffers_view::begin() const -> +buffer_cat_view::begin() const -> const_iterator { return const_iterator{bn_, false}; @@ -480,7 +480,7 @@ buffers_view::begin() const -> template inline auto -buffers_view::end() const -> +buffer_cat_view::end() const -> const_iterator { return const_iterator{bn_, true}; diff --git a/include/beast/http/serializer.hpp b/include/beast/http/serializer.hpp index 05f6dc49..4e45c362 100644 --- a/include/beast/http/serializer.hpp +++ b/include/beast/http/serializer.hpp @@ -162,14 +162,14 @@ class serializer using is_deferred = typename reader::is_deferred; - using cb0_t = consuming_buffers>; // body using cb1_t = consuming_buffers< typename reader::const_buffers_type>; // body - using ch0_t = consuming_buffers>; // crlf - using ch1_t = consuming_buffers>; // crlf - using ch2_t = consuming_buffers>; // crlf diff --git a/test/core/consuming_buffers.cpp b/test/core/consuming_buffers.cpp index afd43f58..17e3e843 100644 --- a/test/core/consuming_buffers.cpp +++ b/test/core/consuming_buffers.cpp @@ -120,7 +120,7 @@ public: void testInPlace() { - consuming_buffers> cb( boost::in_place_init,