std::execution::read_env

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

実行制御ライブラリ

実行コンセプト scheduler receiver receiver_of operation_state    sender sender_in sender_to 実行コンポーネント 実行コンテキスト run_loop 実行ドメイン default_domain 前方進行保証 forward_progress_guarantee 環境 empty_env    get_env    env_of_t 問い合わせ std::stop_token_of_t std::get_stop_token std::get_allocator std::forwarding_query get_scheduler get_domain get_forward_progress_guarantee get_delegation_scheduler get_completion_scheduler 完了シグネチャ completion_signatures completion_signatures_of_t transform_completion_signatures transform_completion_signatures_of    value_types_of_t error_types_of_t    tag_of_t sends_stopped    Senderアダプタクロージャ sender_adaptor_closure コルーチンユーティリティ as_awaitable with_awaitable_senders

中核操作 操作状態 connect connect_result_t start 完了 set_value set_error set_stopped 変換 transform_env transform_sender apply_sender Senderアルゴリズム Senderファクトリ just just_error just_stopped read_env schedule schedule_result_t Senderアダプタ starts_on continues_on    on then upon_error upon_stopped let_value let_error let_stopped schedule_from when_all when_all_with_variant into_variant stopped_as_optional stopped_as_error bulk split Senderコンシューマ this_thread::sync_wait this_thread::sync_wait_with_variant

 

ヘッダ <execution> で定義
inline constexpr /*未指定*/ read_env{};		(C++26以降) (カスタマイズポイントオブジェクト)
呼び出しシグネチャ
execution::sender auto read_env( auto&& query );		(C++26以降)

指定されたクエリオブジェクトに関連付けられた現在の値を取得するために、レシーバーの環境にアクセスする sender を返す sender ファクトリです。

任意のクエリオブジェクト q に対して、式 read_env(q) は /*make-sender*/(read_env, q) と 式同等です。

カスタマイゼーションポイントオブジェクト

execution::read_env という名前は、関数オブジェクトであり、リテラルなsemiregularクラス型の const なカスタム化ポイントオブジェクトを指します。説明のために、その型の cv 修飾されていないバージョンは __read_env_fn と表記されます。

__read_env_fn のすべてのインスタンスは等価です。同じ引数に対して異なる __read_env_fn 型のインスタンスを呼び出した効果は、インスタンスを表す式が左辺値か右辺値か、また const 修飾されているかどうかにかかわらず、同等です（ただし、volatile 修飾されたインスタンスは呼び出し可能であることが要求されません）。したがって、execution::read_env は自由にコピーでき、そのコピーは相互に交換可能です。

型 Args... のセットが与えられた場合、std::declval<Args>()... が上記の execution::read_env への引数の要件を満たす場合、__read_env_fn は以下をモデル化します。

• std::invocable<__read_env_fn, Args...>,
• std::invocable<const __read_env_fn, Args...>,
• std::invocable<__read_env_fn&, Args...>、および
• std::invocable<const __read_env_fn&, Args...>.
  

それ以外の場合、__read_env_fn の関数呼び出し演算子はオーバーロード解決に参加しません。

例

このファクトリの使用例として、read_env(get_scheduler) を使用して取得できるレシーバーのスケジューラに依存する作業をスケジュールすることが挙げられます。

std::execution::sender auto task =
  std::execution::read_env(std::execution::get_scheduler)
    | std::execution::let_value([](auto sched) {
        return std::execution::starts_on(sched, /*some nested work here*/);
    });
 
std::this_thread::sync_wait( std::move(task) ); // wait for it to finish