std::experimental::scope_exit

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

實驗性

技術規範

檔案系統庫 (檔案系統 TS)

庫基礎 (庫基礎 TS)

庫基礎 2 (庫基礎 TS v2)

庫基礎 3 (庫基礎 TS v3)

並行性擴充套件 (並行性 TS)

並行性擴充套件 2 (並行性 TS v2)

併發性擴充套件 (併發性 TS)

併發擴充套件2 (併發 TS v2)

概念 (概念 TS)

範圍 (範圍 TS)

反射 (反射 TS)

數學特殊函式 (特殊函式 TR)

實驗性非 TS

模式匹配

線性代數

std::execution

契約

2D 圖形

 

庫基礎 v3

experimental::scope_exit

experimental::scope_fail

experimental::scope_success

experimental::unique_resource

 

std::experimental::scope_exit

成員函式

scope_exit::scope_exit

scope_exit::~scope_exit

修改器

scope_exit::release

推導指引

 

定義於標頭檔案 <experimental/scope>
template< class EF > class scope_exit;		(庫基礎 TS v3)

類模板 scope_exit 是一個通用的作用域守衛，旨在當作用域退出時呼叫其退出函式。

scope_exit 不是可複製構造的（CopyConstructible）、可複製賦值的（CopyAssignable）或可移動賦值的（MoveAssignable），但是，如果 EF 滿足某些要求，它可能是可移動構造的（MoveConstructible），這允許將 scope_exit 封裝到另一個物件中。

一個 scope_exit 可以是活動的（active），即在銷燬時呼叫其退出函式，也可以是不活動的（inactive），即在銷燬時什麼也不做。從退出函式構造後，scope_exit 是活動的。

一個 scope_exit 可以透過手動或自動（透過移動建構函式）呼叫其 release() 來變得不活動。不活動的 scope_exit 也可以透過用另一個不活動的 scope_exit 初始化來獲得。一旦 scope_exit 不活動，它就不能再次變為活動。

一個 scope_exit 有效地持有一個 EF 和一個 bool 標誌，指示它是否活動。

模板引數

EF	-	儲存的退出函式的型別
型別要求
- EF 應為以下之一： 一個可銷燬的（Destructible）函式物件（FunctionObject）型別， 一個對 FunctionObject 的左值引用， 一個對函式的左值引用。
- 使用無引數呼叫 std::remove_reference_t<EF> 的左值應格式良好。

成員函式

(建構函式)	構造一個新的 scope_exit (公有成員函式)
(解構函式)	如果 scope_exit 處於活動狀態，則在作用域退出時呼叫退出函式，然後銷燬 scope_exit (公有成員函式)
operator= [已刪除]	scope_exit 不可賦值 (公開成員函式)
修改器
release	使 scope_exit 不活動 (公有成員函式)

注意

構造動態儲存期的 scope_exit 可能會導致意外行為。

如果 scope_exit 物件中儲存的 EF 引用了其定義函式中的區域性變數（例如，作為透過引用捕獲變數的 lambda），並且該變數在該函式中用作返回運算元，則當 scope_exit 的解構函式執行並呼叫退出函式時，該變數可能已經返回。這可能導致令人驚訝的行為。

示例

執行此程式碼

#include <iostream>
#include <cstdlib>
#include <string_view>
#include <experimental/scope>
 
void print_exit_status(std::string_view name, bool exit_status, bool did_throw) {
  std::cout << name << ":\n";
  std::cout << "  Throwed exception  " << (did_throw ? "yes" : "no") << "\n";
  std::cout << "  Exit status        " << (exit_status ? "finished" : "pending") << "\n\n";
}
 
// Randomly throw an exception (50% chance)
void maybe_throw() {
    if (std::rand() >= RAND_MAX / 2)
        throw std::exception{};
}
 
int main() {
  bool exit_status{false}, did_throw{false};
 
  // Manual handling at "end of scope"
  try {
    maybe_throw();
    exit_status = true; 
  } catch (...) { did_throw = true; }
  print_exit_status("Manual handling", exit_status, did_throw);
 
  // Using scope_exit: runs on scope exit (success or exception)
  exit_status = did_throw = false;
  try {
    auto guard = std::experimental::scope_exit{[&]{ exit_status = true; } };
    maybe_throw();
  } catch (...) { did_throw = true; }
  print_exit_status("scope_exit", exit_status, did_throw);
 
  // Using scope_fail: runs only if an exception occurs
  exit_status = did_throw = false;
  try {
    auto guard = std::experimental::scope_fail{[&]{ exit_status = true; } };
    maybe_throw();
  } catch (...) { did_throw = true; }
  print_exit_status("scope_fail", exit_status, did_throw);
 
  // Using scope_success: runs only if no exception occurs
  exit_status = did_throw = false;
  try {
    auto guard = std::experimental::scope_success{[&]{ exit_status = true; } };
    maybe_throw();
  } catch (...) { did_throw = true; }
  print_exit_status("scope_success", exit_status, did_throw);
}

輸出

Manual handling:
  Throwed exception  yes
  Exit status        pending
 
scope_exit:
  Throwed exception  no
  Exit status        finished
 
scope_fail:
  Throwed exception  yes
  Exit status        finished
 
scope_success:
  Throwed exception  yes
  Exit status        pending

另見

scope_fail	封裝一個函式物件並在透過異常退出作用域時呼叫它 (類模板)
scope_success	封裝一個函式物件並在正常退出作用域時呼叫它 (類模板)
default_delete (C++11)	unique_ptr 的預設刪除器 (類模板)