Stronger buffer contract on flat_buffer and flat_static_buffer

Fixes #1513
This commit is contained in:
Mohammad Nejati
2024-01-05 07:39:44 +00:00
committed by Mohammad Nejati
parent 9d5ee3fc43
commit 2216adc013
2 changed files with 7 additions and 7 deletions

View File

@ -43,7 +43,7 @@ namespace beast {
@li Buffer sequences representing the readable and writable
bytes, returned by @ref data and @ref prepare, will have
length one.
a type of net::const_buffer or net::mutable_buffer.
Upon construction, a maximum size for the buffer may be
specified. If this limit is exceeded, the `std::length_error`

View File

@ -19,7 +19,7 @@
namespace boost {
namespace beast {
/** A dynamic buffer using a fixed size internal buffer.
/** A dynamic buffer using a fixed size internal buffer using no memory allocations.
A dynamic buffer encapsulates memory storage that may be
automatically resized as required, where the memory is
@ -37,7 +37,7 @@ namespace beast {
@li Buffer sequences representing the readable and writable
bytes, returned by @ref data and @ref prepare, will have
length one.
a type of net::const_buffer or net::mutable_buffer.
@li Ownership of the underlying storage belongs to the
derived class.
@ -245,11 +245,11 @@ private:
//------------------------------------------------------------------------------
/** A <em>DynamicBuffer</em> with a fixed size internal buffer.
/** A <em>DynamicBuffer</em> with a fixed size internal buffer using no memory allocations.
Buffer sequences returned by @ref data and @ref prepare
will always be of length one.
This implements a dynamic buffer using no memory allocations.
Buffer sequences representing the readable and writable
bytes, returned by @ref data and @ref prepare, will have
a type of net::const_buffer or net::mutable_buffer.
@tparam N The number of bytes in the internal buffer.