boost::capy::run

run overloads

Synopses

Declared in <boost/capy/ex/run.hpp>

Run a task with a custom stop token.

[[nodiscard]]
auto
run(std::stop_token st);

Run a task with a custom memory resource.

[[nodiscard]]
auto
run(std::pmr::memory_resource* mr);

Bind a task to execute on a specific executor.

template</* implementation-defined */ Ex>
[[nodiscard]]
auto
run(Ex ex);

Run a task with stop token and memory resource.

[[nodiscard]]
auto
run(
    std::stop_token st,
    std::pmr::memory_resource* mr);

Bind a task to an executor with a stop token.

template<Executor Ex>
[[nodiscard]]
auto
run(
    Ex ex,
    std::stop_token st);

Bind a task to an executor with a memory resource.

template<Executor Ex>
[[nodiscard]]
auto
run(
    Ex ex,
    std::pmr::memory_resource* mr);

Run a task with stop token and standard allocator.

template</* implementation-defined */ Alloc>
[[nodiscard]]
auto
run(
    std::stop_token st,
    Alloc alloc);

Bind a task to an executor with a standard allocator.

template<
    Executor Ex,
    /* implementation-defined */ Alloc>
[[nodiscard]]
auto
run(
    Ex ex,
    Alloc alloc);

Bind a task to an executor with stop token and memory resource.

template<Executor Ex>
[[nodiscard]]
auto
run(
    Ex ex,
    std::stop_token st,
    std::pmr::memory_resource* mr);

Bind a task to an executor with stop token and standard allocator.

template<
    Executor Ex,
    /* implementation-defined */ Alloc>
[[nodiscard]]
auto
run(
    Ex ex,
    std::stop_token st,
    Alloc alloc);

Return Value

A wrapper that accepts a task for execution.

Parameters

Name Description

st

The stop token for cooperative cancellation.

mr

The memory resource for frame allocation.

ex

The executor on which the task should run.

alloc

The allocator for frame allocation.

See Also

task

executor

Created with MrDocs