class future

Declaration

template <typename R>
class future { /* full declaration omitted */ };

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/futures/include/pika/futures/future.hpp:617

Method Overview

• public future<R>() noexcept
• public future<R>(future<R> && other) noexcept
• public future<R>(future<future<R>> && other) noexcept
• public future<R>(future<shared_future<R>> && other) noexcept
• public template <typename T> future<R>(future<T> && other, std::enable_if_t<std::is_void_v<R> && !traits::is_future_v<T>, T> * = nullptr)
• public typename pika::traits::future_traits<future<R>>::result_type get()
• public typename pika::traits::future_traits<future<R>>::result_type get(pika::error_code & ec)
• public shared_future<R> share() noexcept
• public template <typename F>decltype(auto) then(F && f, pika::error_code & ec = throws)
• public template <typename T0, typename F>decltype(auto) then(T0 && t0, F && f, pika::error_code & ec = throws)
• public template <typename Allocator, typename F>auto then_alloc(const Allocator & alloc, F && f, pika::error_code & ec = throws) -> decltype(base_type::then_alloc(alloc, static_cast<std::remove_reference_t<decltype(*this)> &&>(*this), static_cast<decltype(f) &&>(f), ec))
• public ~future<R>()

Methods

future<R>() noexcept

Declared at: libs/pika/futures/include/pika/futures/future.hpp:687

future<R>(future<R>&& other) noexcept

Declared at: libs/pika/futures/include/pika/futures/future.hpp:695

Parameters

future<R>&& other

future<R>(future<future<R>>&& other) noexcept

Declared at: libs/pika/futures/include/pika/futures/future.hpp:703

Parameters

future<future<R>>&& other

future<R>(
    future<shared_future<R>>&& other) noexcept

Declared at: libs/pika/futures/include/pika/futures/future.hpp:715

Parameters

future<shared_future<R>>&& other

template <typename T>
future<R>(
    future<T>&& other,
    std::enable_if_t<std::is_void_v<R> &&
                         !traits::is_future_v<T>,
                     T>* = nullptr)

Declared at: libs/pika/futures/include/pika/futures/future.hpp:728

Parameters

future<T>&& other

std::enable_if_t<std::is_void_v<R> && !traits::is_future_v<T>, T>* = nullptr

typename pika::traits::future_traits<
    future<R>>::result_type
get()

Declared at: libs/pika/futures/include/pika/futures/future.hpp:771

typename pika::traits::future_traits<
    future<R>>::result_type
get(pika::error_code& ec)

Declared at: libs/pika/futures/include/pika/futures/future.hpp:790

Parameters

pika::error_code& ec

shared_future<R> share() noexcept

Declared at: libs/pika/futures/include/pika/futures/future.hpp:755

template <typename F>
decltype(auto) then(F&& f,
                    pika::error_code& ec = throws)

Declared at: libs/pika/futures/include/pika/futures/future.hpp:823

Parameters

F&& f

pika::error_code& ec = throws

template <typename T0, typename F>
decltype(auto) then(T0&& t0,
                    F&& f,
                    pika::error_code& ec = throws)

Declared at: libs/pika/futures/include/pika/futures/future.hpp:842

Parameters

T0&& t0

F&& f

pika::error_code& ec = throws

template <typename Allocator, typename F>
auto then_alloc(const Allocator& alloc,
                F&& f,
                pika::error_code& ec = throws)
    -> decltype(base_type::then_alloc(
        alloc,
        static_cast<std::remove_reference_t<
            decltype(*this)>&&>(*this),
        static_cast<decltype(f)&&>(f),
        ec))

Declared at: libs/pika/futures/include/pika/futures/future.hpp:857

Parameters

const Allocator& alloc

F&& f

pika::error_code& ec = throws

~future<R>()

Declared at: libs/pika/futures/include/pika/futures/future.hpp:742