boost::capy::ready

ready overloads

Synopses

Create an immediate awaitable for a successful io_result.

Create an immediate awaitable for a failed io_result.

immediate<io_result>
ready(std::error_code ec) noexcept;

Create an immediate awaitable for a successful io_result with one value.

template<class T1>
immediate<io_result<T1>>
ready(T1 t1);

Create an immediate awaitable for an io_result with error and one value.

template<class T1>
immediate<io_result<T1>>
ready(
    std::error_code ec,
    T1 t1);

Create an immediate awaitable for a successful io_result with two values.

template<
    class T1,
    class T2>
immediate<io_result<T1, T2>>
ready(
    T1 t1,
    T2 t2);

Create an immediate awaitable for an io_result with error and two values.

template<
    class T1,
    class T2>
immediate<io_result<T1, T2>>
ready(
    std::error_code ec,
    T1 t1,
    T2 t2);

Create an immediate awaitable for a successful io_result with three values.

template<
    class T1,
    class T2,
    class T3>
immediate<io_result<T1, T2, T3>>
ready(
    T1 t1,
    T2 t2,
    T3 t3);

Create an immediate awaitable for an io_result with error and three values.

template<
    class T1,
    class T2,
    class T3>
immediate<io_result<T1, T2, T3>>
ready(
    std::error_code ec,
    T1 t1,
    T2 t2,
    T3 t3);

Return Value

  • An immediate awaitable containing a successful io_result.

  • An immediate awaitable containing a failed io_result.

  • An immediate awaitable containing io_result<T1>{{}, t1}.

  • An immediate awaitable containing io_result<T1>{ec, t1}.

  • An immediate awaitable containing io_result<T1,T2>{{}, t1, t2}.

  • An immediate awaitable containing io_result<T1,T2>{ec, t1, t2}.

  • An immediate awaitable containing io_result<T1,T2,T3>{{}, t1, t2, t3}.

  • An immediate awaitable containing io_result<T1,T2,T3>{ec, t1, t2, t3}.

Parameters

Name Description

ec

The error code.

t1

The result value.

t2

The second result value.

t3

The third result value.

See Also

immediate, io_result

Created with MrDocs