rustでexpect("Err")の"Err"だけを出力したい

Question

let text:i32 = text.parse::<i32>().expect("Err");

でtextが"hello"とかだと

thread 'main' panicked at 'Err: ParseIntError { kind: InvalidDigit }', src/main.rs:7:20
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

のようになりますが
"Err"のみをログに出すことはできますか

方法を教えて欲しいです。
よろしくお願いします。

Answer 1

こんにちは。
回答の前にまずパニック（expectの中身）について認識をすりあわせたいです。

パニックは回復不能なエラー、プログラムのバグでないと起きえないことが起きたときに使う回復不能なエラーです（参考 panic!で回復不能なエラー）。他の言語でいう例外は Result 型が担当するので、例外のような気持で使うものではありません。なのでパニックを使いつつユーザフレンドリなエラーメッセージを残そうとしているときは、使い方を間違っている可能性があります。

このような前提の下で、もしやりたいことが「エラーメッセージを出して終了したい」だけならパニックを使わずに以下のような書き方があります。

use std::process::exit;

let text = match text.parse::<i32>() {
    Ok(text) => text,
    Err(_) => {
        // エラー出力にログを出す
        eprintln!("Err");
        // プログラムをエラー終了する
        exit(1)
    }
};

さらにもし、やりたいことが「"Err" をログに出す」だけが目的なら exit を呼ぶのは不適当です。 exit を呼んだらプログラムが終了してしまいます。
とはいえ、エラーだと数値が取り出せないので適当なエラー値を返して関数から抜けることになるかと思います。

use std::error::Error as StdError;
use std::fmt;

// 関数か抜けるときの値を用意
#[derive(Debug)]
enum Error {
    UserInputError
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Error::UserInputError => write!(f, "Err"),
        }
    }
}

// エラーを実装しておくと扱いやすい
impl StdError for Error {}

// 処理する関数
fn hogehoge(text: String) -> Result<i32, Error> {
    let text = match text.parse::<i32>() {
        Ok(text) => text,
        Err(_) => {
            eprintln!("Err");
            return Err(Error::UserInputError);
        }
    };
    Ok(text)
}

ここでは文脈がないので Error を定義して返しましたが、もし文脈的に io::Error が適当なら io::Error を返してもいいです。

最後に、もし本当に回復不能なエラーを使った上で、それを処理したいという特殊用途であれば std::panic::set_hook がありますが、メッセージだけを取り出すのは難しそうでした。

use std::panic;

fn main() {
    panic::set_hook(Box::new(|panic| {
        if let Some(payload) = panic.payload().downcast_ref::<String>() {
            eprintln!("{}", payload);
        } else {
            eprintln!("{}", panic);
        }
    }));

    let text = "hello";
    let text = text.parse::<i32>().expect("Err");
}

Err: ParseIntError { kind: InvalidDigit }

exit を呼ぶ方法、Error を定義して関数から抜ける方法、パニックハンドラを使う方法の3つを提示しましたが、恐らく exit を呼ぶ方法が無難だと思います。
複雑なことをやりはじめたら Error を定義して使う方法に移行して下さい。 Error を定義して使う方法は公式ドキュメントなどを参考にして下さい： Resultで回復可能なエラー

Comments

[toriumi_haru]

様々な方法を提示していただいてありがとうございます！
これから場面に合わせて使い分けてみようと思います！

Answer 2

std::panic::set_hookを使えば可能です。

panic!や.expect(_)、todo!、unreachable!だとPanicInfo::payloadは&'static strかStringなので、std::any::Any::downcast_refで条件分岐すれば良いです。

use std::panic;

panic::set_hook(Box::new(|panic| {
    if let Some(payload) = panic.payload().downcast_ref::<&str>() {
        eprintln!("{}", payload);
    } else if let Some(payload) = panic.payload().downcast_ref::<String>() {
        eprintln!("{}", payload);
    } else {
        eprintln!("{}", panic);
    }
}));

panic!("Panic message");

$ cargo run
   Compiling a v0.0.0 (/home/ryo/src/local/scripts/rs/a)
    Finished dev [unoptimized + debuginfo] target(s) in 0.31s
     Running `/home/ryo/src/local/scripts/rs/target/debug/a`
Panic message

(追記1) ParseIntErrorを無視するなら.expect("メッセージ")のかわりに.ok().expect("メッセージ")か、.unwrap_or_else(|_| panic!("メッセージ"))とすれば良いです。

(追記2) .ok().expect(_)はClippy (Rustツールチェインに付いてくるlint)のwarning対象のようです。

ところで前の質問でのコードでも触れましたが、mainの返り値には()の他にResult<(), E> (E: Debug)が使えます。 こちらを使うことをおすすめします。

mainの返り値をResultして実際にErrが返される場合、Error: {Debug表記}というエラーメッセージになります。

• 3.3.2. ? in main and tests - The Edition Guide
• std::fmt::Debug

use std::fmt;

fn main() -> Result<(), MyError> {
    Err(MyError)
}

struct MyError;

impl fmt::Debug for MyError {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "Debug表記")
    }
}

$ cargo run
   Compiling a v0.0.0 (/home/ryo/src/local/scripts/rs/a)
    Finished dev [unoptimized + debuginfo] target(s) in 0.24s
     Running `/home/ryo/src/local/scripts/rs/target/debug/a`
Error: Debug表記

(Result<(), String>やResutl<() &'static str>とした場合、Error: "エラーメッセージ"のように""付きで表示されてしまいます。)

現在(特に小規模なアプリケーションでは)エラー型にanyhow::Errorを使うことが推奨されています。 anyhow::ErrorのDebug表示では中身のエラーはDebugではなくDisplayで表示されます。 またstd::error::Error::sourceの内容も表示してくれます。

(追記1) このコードを貼るのを忘れてました...

use anyhow::Context as _;
use std::fs;

fn main() -> anyhow::Result<()> {
    let _content = fs::read_to_string("./nonexisting-file")
        .with_context(|| "Failed to read ./nonexisting-file")?;

    Ok(())
}

$ cargo add anyhow
    Updating 'https://github.com/rust-lang/crates.io-index' index
      Adding anyhow v1.0.31 to dependencies
$ cargo run
   Compiling a v0.0.0 (/home/ryo/src/local/scripts/rs/a)
    Finished dev [unoptimized + debuginfo] target(s) in 0.32s
     Running `/home/ryo/src/local/scripts/rs/target/debug/a`
Error: Failed to read ./nonexisting-file

Caused by:
    No such file or directory (os error 2)

Comments

[qryxip]

質問は

> "Err"のみをログに出すことはできますか

でしたね。 `ParseIntError`を無視するなら`.expect("メッセージ")`のかわりに`.unwrap_or_else(|| panic!("メッセージ"))`とすることで可能です。

あと最後の例、このコードを貼るのを忘れてました...

```rust
use anyhow::Context as _;
use std::fs;

fn main() -> anyhow::Result<()> {
let _content = fs::read_to_string("./nonexisting-file")
.with_context(|| "Failed to read ./nonexisting-file")?;

Ok(())
}
```

[qryxip]

回答の編集ができるようなので編集で追記しました。

[toriumi_haru]

こちらの質問にも回答していただきありがとうございます！
rustはまだthe bookのエラー処理の前までしか読めておらず、まだまだわからないことが多いのでこれからも教えてくださると嬉しいです！