result

目的もくてき

• 処理しょりの成功せいこう / 失敗しっぱいを値あたいとして明示的めいじてきに扱あつかうための Result と基本操作きほんそうさを提供ていきょうします。
• reboot 後ごの stdlib で「安全あんぜん API は Result / Outcome を返かえす」という方針ほうしんを支ささえる最小基盤さいしょうきばんです。

注意ちゅうい

• unwrap_ok / unwrap_err は便宜上べんぎじょう残のこしている unsafe helper であり、通常つうじょうは match や unwrap_or を優先ゆうせんしてください。
• doctest では trap 依存いぞんの should_panic を使つかわず、安全あんぜんな分岐ぶんきと ret: 比較ひかくで確認かくにんします。

計算量けいさんりょう

• 基本操作きほんそうさはすべて O(1) です。

#entry main
#target std
#import "std/test" as *
#import "core/result" as *
fn main <()*>i32> ():
    let checks <Vec<Result<(),str>>>:
        checks_new
        |> checks_push assert is_ok ok<i32, str> 1
        |> checks_push assert is_err err<i32, str> "oops"
        |> checks_push assert_eq_i32 1 unwrap_ok ok<i32, str> 1
        |> checks_push assert_str_eq "oops" unwrap_err err<i32, str> "oops"
        |> checks_push assert_eq_i32 9 unwrap_or err<i32, str> "x" 9
    checks_exit_code checks

#entry main
#target std
#import "core/result" as *
// 型が合わない Err を入れているのでコンパイルエラーを期待
fn main <()*>()> ():
    let r <i32> "text";
    r

#entry main
#target std
#import "std/test" as *
#import "core/result" as *
#import "core/math" as *
fn inc <(i32)->i32> (x):
    add x 1

fn strlen <(str)->i32> (s):
    4

fn main <()*>i32> ():
    let a map ok<i32,str> 9 inc;
    let b map_err err<i32,str> "oops" strlen;
    let checks <Vec<Result<(),str>>>:
        checks_new
        |> checks_push assert_eq_i32 10 unwrap_ok a
        |> checks_push assert_eq_i32 4 unwrap_err b
    checks_exit_code checks

Result: 成功(Ok)か失敗(Err)を表す

目的:

• 成功値 .T と失敗値 .E を区別して保持します。

実装(アルゴリズム):

• enum の 2 変種で表現します。

注意(重要):

• Ok/Err は payload を保持します。

計算量:

• O(1)

ok: 成功値を包む

目的:

• v を Ok として返します。

実装(アルゴリズム):

• Result::Ok を構築します。

注意(重要):

• .E は文脈で決まります。

計算量:

• O(1)

err: 失敗値を包む

目的:

• e を Err として返します。

実装(アルゴリズム):

• Result::Err を構築します。

注意(重要):

• .T は文脈で決まります。

計算量:

• O(1)

is_ok: 成功か判定する

目的:

• Ok なら true、Err なら false を返します。

実装(アルゴリズム):

• match で Ok/Err を分岐します。

注意(重要):

• 値そのものは取り出しません。

計算量:

• O(1)

is_err: 失敗か判定する

目的:

• Err なら true、Ok なら false を返します。

実装(アルゴリズム):

• match で Ok/Err を分岐します。

注意(重要):

• is_ok の否定です。

計算量:

• O(1)

unwrap_ok: Ok の中身を取り出す（Err は到達不能）

目的:

• Ok(v) なら v を返します。

実装(アルゴリズム):

• match で分岐し、Err は unreachable を呼びます。

注意(重要):

• Err の可能性がある場合は is_ok や unwrap_or を使ってください。

計算量:

• O(1)

uwok

unwrap_ok の短縮名たんしゅくめい

#entry main
#target std
#import "std/test" as *
#import "core/result" as *
fn main <()*>i32> ():
    assert_eq_i32 1 uwok ok<i32, str> 1;
    0

uwerr

unwrap_err の短縮名たんしゅくめい