boost::capy::any_read_stream::read_some

Initiate an asynchronous read operation.

Synopsis

Declared in <boost/capy/io/any_read_stream.hpp>

template<MutableBufferSequence MB>
auto
read_some(MB buffers);

Description

Reads data into the provided buffer sequence. The operation completes when at least one byte has been read, or an error occurs.

Immediate Completion

The operation completes immediately without suspending the calling coroutine when the underlying stream's awaitable reports immediate readiness via await_ready.

This is a partial operation and may not process the entire buffer sequence. Use the composed read algorithm for guaranteed complete transfer.

Preconditions

The wrapper must contain a valid stream (has_value() == true). The caller must not call this function again after a prior call returned an error (including EOF).

Return Value

An awaitable yielding (error_code,std::size_t).

Parameters

Name Description

buffers

The buffer sequence to read into. Passed by value to ensure the sequence lives in the coroutine frame across suspension points.

Created with MrDocs