class shared_future

Declaration

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

Description

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

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

Method Overview

• public typename pika::traits::future_traits<shared_future<R>>::result_type get() const
• public typename pika::traits::future_traits<shared_future<R>>::result_type get(pika::error_code & ec) const
• public shared_future<R>() noexcept
• public shared_future<R>(const shared_future<R> & other)
• public shared_future<R>(shared_future<R> && other) noexcept
• public shared_future<R>(future<R> && other) noexcept
• public shared_future<R>(future<shared_future<R>> && other) noexcept
• public template <typename T> shared_future<R>(const shared_future<T> & other, std::enable_if_t<std::is_void_v<R> && !traits::is_future_v<T>, T> * = nullptr)
• public template <typename F>decltype(auto) then(F && f, pika::error_code & ec = throws) const
• public template <typename T0, typename F>decltype(auto) then(T0 && t0, F && f, pika::error_code & ec = throws) const
• 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 ~shared_future<R>()

Methods

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

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

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

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

Parameters

pika::error_code& ec

shared_future<R>() noexcept

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

shared_future<R>(const shared_future<R>& other)

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

Parameters

const shared_future<R>& other

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

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

Parameters

shared_future<R>&& other

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

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

Parameters

future<R>&& other

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

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

Parameters

future<shared_future<R>>&& other

template <typename T>
shared_future<R>(
    const shared_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:1028

Parameters

const shared_future<T>& other

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

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

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

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) const

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

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:1151

Parameters

const Allocator& alloc

F&& f

pika::error_code& ec = throws

~shared_future<R>()

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