...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Read data into a dynamic buffer sequence until it contains a specified delimiter.
template< typename SyncReadStream, typename DynamicBuffer> std::size_t read_until( SyncReadStream & s, DynamicBuffer && buffers, string_view delim);
This function is used to read data into the specified dynamic buffer sequence until the dynamic buffer sequence's get area contains the specified delimiter. The call will block until one of the following conditions is true:
This operation is implemented in terms of zero or more calls to the stream's read_some function. If the dynamic buffer sequence's get area already contains the delimiter, the function returns immediately.
The stream from which the data is to be read. The type must support the SyncReadStream concept.
The dynamic buffer sequence into which the data will be read.
The delimiter string.
The number of bytes in the dynamic buffer sequence's get area up to and including the delimiter.
After a successful read_until operation, the dynamic buffer sequence may contain additional data beyond the delimiter. An application will typically leave that data in the dynamic buffer sequence for a subsequent read_until operation to examine.
To read data into a std::string
until a CR-LF sequence is
encountered:
std::string data; std::string n = boost::asio::read_until(s, boost::asio::dynamic_buffer(data), "\r\n"); std::string line = data.substr(0, n); data.erase(0, n);
After the read_until
operation completes successfully, the
string data
contains the delimiter:
{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
The call to substr
then extracts the data up to and including
the delimiter, so that the string line
contains:
{ 'a', 'b', ..., 'c', '\r', '\n' }
After the call to erase
, the remaining data is left in the
buffer b
as follows:
{ 'd', 'e', ... }
This data may be the start of a new line, to be extracted by a subsequent
read_until
operation.