Skip to content

Commit

Permalink
expected/expected.void: コンストラクタ,デストラクタ(#1066)
Browse files Browse the repository at this point in the history 
実験的に`expected<T,E>`プライマリテンプレートと`expected<cv void,E>`部分特殊化を
フォルダ構造分離したうえで各種メンバの説明ページを作成してみる。
  • Loading branch information
@yohhoy
yohhoy committed Feb 9, 2023
1 parent ebf409b commit 996f8d3
Show file tree
Hide file tree
Showing 4 changed files with 348 additions and 4 deletions.
51 changes: 49 additions & 2 deletions reference/expected/expected.md
View file
Expand Up @@ -6,10 +6,11 @@

```cpp
namespace std {
// プライマリテンプレート
template<class T, class E>
class expected;

// T=cv void 部分特殊化
// T=cv void 部分特殊化テンプレート
template<class T, class E>
requires is_void_v<T>
class expected<T, E>;
Expand All @@ -27,7 +28,7 @@ namespace std {
- 型`E`はCpp17Destructible要件を満たすこと。
## メンバ関数
## メンバ関数（プライマリテンプレート）
### 構築・破棄
| 名前 | 説明 | 対応バージョン |
Expand Down Expand Up @@ -73,6 +74,52 @@ namespace std {
| [`operator!=`](expected/op_not_equal.md) | 非等値比較 | C++23 |
## メンバ関数（T=cv void 部分特殊化テンプレート）
### 構築・破棄
| 名前 | 説明 | 対応バージョン |
|-----------------|----------------|-------|
| [`(constructor)`](expected.void/op_constructor.md) | コンストラクタ | C++23 |
| [`(destructor)`](expected.void/op_destructor.md) | デストラクタ | C++23 |
### 代入
| 名前 | 説明 | 対応バージョン |
|-----------------|----------------|-------|
| [`operator=`](expected.void/op_assign.md.nolink) | 代入演算子 | C++23 |
| [`emplace`](expected.void/emplace.md.nolink) | 正常値型のコンストラクタ引数から直接構築する | C++23 |
| [`swap`](expected.void/swap.md.nolink) | 他の`expected`オブジェクトとデータを入れ替える | C++23 |
### 値の観測
| 名前 | 説明 | 対応バージョン |
|-----------------|----------------|-------|
| [`operator*`](expected.void/op_deref.md.nolink) | 正常値への間接参照 | C++23 |
| [`operator bool`](expected.void/op_bool.md.nolink) | 正常値を保持しているかを判定する | C++23 |
| [`has_value`](expected.void/has_value.md.nolink) | 正常値を保持しているかを判定する | C++23 |
| [`value`](expected.void/value.md.nolink) | 正常値を取得する | C++23 |
| [`error`](expected.void/error.md.nolink) | エラー値を取得する | C++23 |
| [`error_or`](expected.void/error_or.md.nolink) | エラー値もしくは指定された値を取得する | C++23 |
（`expected<cv void, E>` 部分特殊化では、演算子オーバーロード`operator->`およびメンバ関数`value`は提供されない。）
### モナド操作
| 名前 | 説明 | 対応バージョン |
|------|------|----------------|
| [`and_then`](expected.void/and_then.md.nolink) | 正常値に対して関数を適用する | C++23 |
| [`or_else`](expected.void/or_else.md.nolink) | エラー値に対して関数を適用する | C++23 |
| [`transform`](expected.void/transform.md.nolink) | 正常値を変換する | C++23 |
| [`transform_error`](expected.void/transform_error.md.nolink) | エラー値を変換する | C++23 |
### 比較
| 名前 | 説明 | 対応バージョン |
|--------------|------------|-------|
| [`operator==`](expected.void/op_equal.md.nolink) | 等値比較 | C++23 |
| [`operator!=`](expected.void/op_not_equal.md.nolink) | 非等値比較 | C++23 |
## メンバ型
| 名前 | 説明 | 対応バージョン |
Expand Down
259 changes: 259 additions & 0 deletions reference/expected/expected.void/op_constructor.md
View file
@@ -0,0 +1,259 @@
# コンストラクタ
* expected[meta header]
* function[meta id-type]
* std[meta namespace]
* expected[meta class]
* cpp23[meta cpp]

```cpp
// expected<cv void, E>部分特殊化
constexpr expected(); // (1)
constexpr expected(const expected& rhs); // (2)
constexpr expected(expected&& rhs) noexcept(see below); // (3)

template<class U, class G>
constexpr explicit(see below) expected(const expected<U, G>& rhs); // (4)
template<class U, class G>
constexpr explicit(see below) expected(expected<U, G>&& rhs); // (5)

template<class G>
constexpr explicit(see below) expected(const unexpected<G>& e); // (6)
template<class G>
constexpr explicit(see below) expected(unexpected<G>&& e); // (7)

constexpr explicit expected(in_place_t) noexcept; // (8)

template<class... Args>
constexpr explicit expected(unexpect_t, Args&&... args); // (9)
template<class U, class... Args>
constexpr explicit expected(unexpect_t, initializer_list<U> il, Args&&... args); // (10)
```
* see below[italic]
* unexpected[link ../unexpected.md]
* unexpect_t[link ../unexpect_t.md]
* in_place_t[link /reference/utility/in_place_t.md]
* initializer_list[link /reference/initializer_list/initializer_list.md]
## 概要
- (1) : 正常値を保持する。
- (2) : コピーコンストラクタ。
- (3) : ムーブコンストラクタ。
- (4) : 変換可能な`expected<cv void, G>`オブジェクトからコピー構築する。
- (5) : 変換可能な`expected<cv void, G>`オブジェクトからムーブ構築する。
- (6) : 変換可能な[`unexpected`](../unexpected.md)オブジェクトかエラー値をコピー構築する。
- (7) : 変換可能な[`unexpected`](../unexpected.md)オブジェクトからエラー値をムーブ構築する。
- (8) : 正常値を保持する。
- (9) : エラー値型`E`のコンストラクタ引数として任意個の引数を受け取って、コンストラクタ内で型`E`のオブジェクトをエラー値として生成し、保持する。
- (10) : エラー値型`E`のコンストラクタ引数として初期化子リストと任意個の引数を受け取って、コンストラクタ内で型`E`のオブジェクトをエラー値として生成し、保持する。
## テンプレートパラメータ制約
- (3) : [`is_move_constructible_v`](/reference/type_traits/is_move_constructible.md)`<E> == true`
- (4) : 次の制約を全て満たすこと
- [`is_void_v`](/reference/type_traits/is_void.md)`<U> == true`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E, const G&> == true`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, expected<U, G>&> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, expected<U, G>> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, const expected<U, G>&> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, const expected<U, G>> == false`
- (5) : 次の制約を全て満たすこと
- [`is_void_v`](/reference/type_traits/is_void.md)`<U> == true`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E, G> == true`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, expected<U, G>&> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, expected<U, G>> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, const expected<U, G>&> == false`
- [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<`[`unexpected`](../unexpected.md)`<E>, const expected<U, G>> == false`
- (6) : [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E, const G&> == true`
- (7) : [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E, G> == true`
- (9) : [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E, Args...> == true`
- (10) : [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<E,` [`initializer_list`](/reference/initializer_list/initializer_list.md)`<U>&, Args...> == true`
## 効果
- (1) : 正常値を保持する。
- (2) : `rhs`がエラー値を保持していれば、`rhs.`[`error()`](error.md.nolink)でエラー値を直接非リスト初期化する。
- (3) : `rhs`がエラー値を保持していれば、[`std::move`](/reference/utility/move.md)`(rhs.`[`error()`](error.md.nolink)`)`でエラー値を直接非リスト初期化する。
- (4) : `rhs`がエラー値を保持していれば、[`std::forward`](/reference/utility/forward.md)`<const G&>(rhs.`[`error()`](error.md.nolink)`)`でエラー値を直接非リスト初期化する。
- (5) : `rhs`がエラー値を保持していれば、[`std::forward`](/reference/utility/forward.md)`<G>(rhs.`[`error()`](error.md.nolink)`)`でエラー値を直接非リスト初期化する。
- (6) : [`std::forward`](/reference/utility/forward.md)`<const G&>(e.`[`error()`](../unexpected/error.md.nolink)`)`でエラー値を直接非リスト初期化する。
- (7) : [`std::forward`](/reference/utility/forward.md)`<G>(e.`[`error()`](../unexpected/error.md.nolink)`)`でエラー値を直接非リスト初期化する。
- (9) : [`std::forward`](/reference/utility/forward.md)`<Args>(args)...`でエラー値を直接非リスト初期化する。
- (10) : `il,` [`std::forward`](/reference/utility/forward.md)`<Args>(args)...`でエラー値を直接非リスト初期化する。
## 事後条件
- (1) : 正常値を保持している。
- (2) : `rhs`が正常値を保持する場合は`*this`も正常値を保持し、`rhs`がエラー値を保持する場合は`*this`もエラー値を保持する。
- (3) : `rhs`が正常値を保持する場合は`*this`も正常値を保持し、`rhs`がエラー値を保持する場合は`*this`もエラー値を保持する。`rhs.`[`has_value()`](has_value.md.nolink)は変化しない。
- (4), (5) : `rhs`が正常値を保持する場合は`*this`も正常値を保持し、`rhs`がエラー値を保持する場合は`*this`もエラー値を保持する。`rhs.`[`has_value()`](has_value.md.nolink)は変化しない。
- (6), (7) : エラー値を保持している。
- (8) : 正常値を保持している。
- (9), (10) : エラー値を保持している。
## 例外
- (2) : エラー値型の初期化から送出される例外。
- (3) : エラー値型の初期化から送出される例外。
- [`is_nothrow_move_constructible_v`](/reference/type_traits/is_nothrow_move_constructible.md)`<E>`であれば、ムーブコンストラクタはnoexpcet指定される。
- (4), (5) : エラー値型の初期化から送出される例外。
- (6), (7) : エラー値型の初期化から送出される例外。
- (8) : 投げない。
- (9), (10) : エラー値型の初期化から送出される例外。
## delete定義される条件
- (2) : `!`[`is_copy_constructible_v`](/reference/type_traits/is_copy_constructible.md)`<E>`
## トリビアルに定義される条件
- (2) : [`is_trivially_copy_constructible_v`](/reference/type_traits/is_trivially_copy_constructible.md)`<E>`
- (3) : [`is_trivially_move_constructible_v`](/reference/type_traits/is_trivially_move_constructible.md)`<E>`
## explicitになる条件
- (4) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<const G&, E>`
- (5) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<G, E>`
- (6) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<const G&, E>`
- (7) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<G, E>`
## 例
```cpp example
#include <cassert>
#include <expected>
#include <memory>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include <vector>
// std::pair型から2要素std::tuple型へはコピー変換可能
using IntPair = std::pair<int, int>;
using IntTuple = std::tuple<int, int>;
// std::unique_ptr型からstd::shared_ptr型へはムーブ変換可能
using UniquePtr = std::unique_ptr<int>;
using SharedPtr = std::shared_ptr<int>;
// 引数リスト または 初期化子リスト＋引数リスト から構築可能な型
struct ComplexType {
std::string data;
std::vector<int> seq;
ComplexType(const char* ptr, size_t len)
: data(ptr, len) {}
ComplexType(std::initializer_list<int> il, std::string_view sv)
: data(sv), seq(il) {}
};
int main()
{
// (1) デフォルトコンストラクタ
{
std::expected<void, int> x;
assert(x.has_value());
}
// (2) コピーコンストラクタ
{
std::expected<void, int> srcV;
std::expected<void, int> dstV = srcV;
assert(srcV.has_value() && dstV.has_value());
std::expected<void, int> srcE = std::unexpected{42};
std::expected<void, int> dstE = srcE;
assert(!srcE.has_value() && !dstE.has_value());
assert(srcE.error() == 42 && dstE.error() == 42);
}
// (3) ムーブコンストラクタ
{
std::expected<void, std::string> srcV;
std::expected<void, std::string> dstV = std::move(srcV);
assert(srcV.has_value() && dstV.has_value());
std::expected<void, std::string> srcE = std::unexpected{"Oops"};
std::expected<void, std::string> dstE = std::move(srcE);
assert(!srcE.has_value() && !dstE.has_value());
assert(dstE.error() == "Oops");
// srcE.error()はstd::stringムーブ後の未規定の値
}
// (4) 変換コピー構築
{
std::expected<void, IntPair> src = std::unexpected{IntPair{1, 2}};
std::expected<void, IntTuple> dst = src;
assert(!src.has_value() && !dst.has_value());
assert((dst.error() == IntTuple{1, 2}));
}
// (5) 変換ムーブ構築
{
std::expected<void, UniquePtr> src = std::unexpected{std::make_unique<int>(42)};
std::expected<void, SharedPtr> dst = std::move(src);
assert(!src.has_value() && !dst.has_value());
assert(*dst.error() == 42);
assert(src.error() == nullptr);
// ムーブ後のstd::unique_ptr型はnullptrが保証される
}
// (6),(7) エラー値の変換コピー／ムーブ構築
{
std::unexpected<IntPair> src1{std::in_place, 1, 2};
std::expected<void, IntTuple> dst1 = src1;
assert(not dst1.has_value());
assert((dst1.error() == IntTuple{1, 2}));
UniquePtr src2 = std::make_unique<int>(42);
std::expected<void, SharedPtr> dst2 = std::unexpected{std::move(src2)};
assert(not dst2.has_value());
assert(*dst2.error() == 42);
}
// (8) 正常値(void)を直接構築
{
std::expected<void, int> x1{std::in_place};
assert(x1.has_value());
}
// (9),(10) 引数リストからエラー値を直接構築
{
std::expected<void, ComplexType> x1{std::unexpect, "C++", 1};
assert(not x1.has_value());
assert(x1.error().data == "C");
// "C++"より長さ1の文字列が構築されている
std::expected<void, ComplexType> x2{std::unexpect, {11, 14, 17, 20, 23}, "C++"};
assert(not x2.has_value());
assert(x2.error().data == "C++");
assert((x2.error().seq == std::vector<int>{11, 14, 17, 20, 23}));
}
}
```
* has_value()[link has_value.md.nolink]
* value()[link value.md.nolink]
* error()[link error.md.nolink]
* std::unexpected[link ../unexpected.md]
* std::unexpect[link ../unexpect_t.md]
* std::in_place[link /reference/utility/in_place_t.md]
* std::make_unique[link /reference/memory/make_unique.md]

### 出力
```
```


## バージョン
### 言語
- C++23

### 処理系
- [Clang](/implementation.md#clang): 16.0
- [GCC](/implementation.md#gcc): 12.1
- [ICC](/implementation.md#icc): ??
- [Visual C++](/implementation.md#visual_cpp): ??


## 参照
- [P0323R12 std::expected](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p0323r12.html)
37 changes: 37 additions & 0 deletions reference/expected/expected.void/op_destructor.md
View file
@@ -0,0 +1,37 @@
# デストラクタ
* expected[meta header]
* function[meta id-type]
* std[meta namespace]
* expected[meta class]
* cpp23[meta cpp]

```cpp
// expected<cv void, E>部分特殊化
constexpr ~expected();
```

## 概要
`expected`オブジェクトを破棄する。


## 効果
エラー値を保持している場合は、エラー値オブジェクトのデストラクタを呼び出す。


## トリビアルに定義される条件
[`is_trivially_destructible_v`](/reference/type_traits/is_trivially_destructible.md)`<E>`


## バージョン
### 言語
- C++23

### 処理系
- [Clang](/implementation.md#clang): 16.0
- [GCC](/implementation.md#gcc): 12.1
- [ICC](/implementation.md#icc): ??
- [Visual C++](/implementation.md#visual_cpp): ??


## 参照
- [P0323R12 std::expected](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p0323r12.html)
5 changes: 3 additions & 2 deletions reference/expected/expected/op_constructor.md
View file
Expand Up @@ -149,8 +149,8 @@ constexpr bool converts-from-any-cvref =


## explicitになる条件
- (4) : `!`[`is_convertible_v`](/reference/type_traits/is_constructible.md)`<const U&, T> || !`[`is_convertible_v`](/reference/type_traits/is_constructible.md)`<const G&, E>`
- (5) : `!`[`is_convertible_v`](/reference/type_traits/is_constructible.md)`<U, T> || !`[`is_convertible_v`](/reference/type_traits/is_constructible.md)`<G, E>`
- (4) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<const U&, T> || !`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<const G&, E>`
- (5) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<U, T> || !`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<G, E>`
- (6) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<U, T>`
- (7) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<const G&, E>`
- (8) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<G, E>`
Expand All @@ -162,6 +162,7 @@ constexpr bool converts-from-any-cvref =
#include <expected>
#include <memory>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include <vector>
Expand Down

0 comments on commit 996f8d3

Please sign in to comment.