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,
    char 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.

Parameters

Return Value

The number of bytes in the dynamic buffer sequence's get area up to and including the delimiter.

Exceptions

Remarks

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.

Example

To read data into a std::string until a newline is encountered:

std::string data;
std::string n = boost::asio::read_until(s,
    boost::asio::dynamic_buffer(data), '\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', '\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', '\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.