boost::capy::any_buffer_source::read_some

Read some data into a mutable buffer sequence.

Synopsis

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

template<MutableBufferSequence MB>
io_task<std::size_t>
read_some(MB buffers);

Description

Reads one or more bytes into the caller's buffers. May fill less than the full sequence.

When the wrapped type provides native ReadSource support, the operation forwards directly. Otherwise it is synthesized from pull, buffer_copy, and consume.

Preconditions

The wrapper must contain a valid source (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 fill.

See Also

pull, consume

Created with MrDocs