boost::capy::any_write_stream::write_some

Initiate an asynchronous write operation.

Synopsis

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

template<ConstBufferSequence CB>
auto
write_some(CB buffers);

Description

Writes data from the provided buffer sequence. The operation completes when at least one byte has been written, or an error occurs.

Immediate Completion

The operation completes immediately without suspending the calling coroutine when:

  • The buffer sequence is empty, returning `{error_code{}, 0}`.

  • 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 write algorithm for guaranteed complete transfer.

Preconditions

The wrapper must contain a valid stream (has_value() == true).

Return Value

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

Parameters

Name Description

buffers

The buffer sequence containing data to write. Passed by value to ensure the sequence lives in the coroutine frame across suspension points.

Created with MrDocs