boost::capy::any_buffer_source::read

Read 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(MB buffers);

Description

Fills the provided buffer sequence completely. When the wrapped type provides native ReadSource support, each window is forwarded directly. Otherwise the data 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). On success, n == buffer_size(buffers). On EOF, ec == error::eof and n is bytes transferred.

Parameters

Name Description

buffers

The buffer sequence to fill.

See Also

pull, consume

Created with MrDocs