Result<T,E> в Rust

В первой задаче Advent of Code я использовал скопипащенный код на Rust, который был мне не до конца понятен… Пора разобраться в нём и записать всё здесь.
Речь о методах .expect и .unwrap().
File::open() в скопипащенном коде без .expect() даёт ошибку компиляции
File::open(filename).expect("error message");
Функция parse в скопипащенном коде без вызова .unwrap() даёт ошибку компиляции
line.parse::<i32>().unwrap();
По сигнатуре std::fs::File::open() видно, что она возвращает не File, а Result<File>. Гугл приводит к главе Error Handling в Rust Book, где объясняется:
В Rust нет исключений. Вместо них есть тип
Result<T, E>для исправимых ошибок и макросpanic!, который останавливает выполнение, когда программа сталкивается с неисправимой ошибкой.
Result<T, E>— это тип, который используется для возврата и распространения ошибок. Это перечисление с вариантамиOk(T), обозначающим успех и содержащим значение, иErr(E), обозначающим ошибку и содержащим значение ошибки.
Обобщённое перечисление Result выглядит так:
enum Result<T, E> {
Ok(T),
Err(E),
}
Получив результат, разработчик должен обработать оба случая: Ok(result) и Err(why). Типичная обработка ошибок в Rust выглядит так:
use std::fs::File;
use std::error::Error;
fn main() {
let path = ".gitignore";
match File::open(&path) {
Err(why) => panic!("couldn't open {}: {}", path, why.description()),
Ok(file) => println!("{:?}", file),
};
}
Вот как Rust Book объясняет этот код:
Если
File::openвыполнится успешно, значением в [конструкции match] будет экземплярOk, содержащий дескриптор файла. Если же произойдёт ошибка, значением в [конструкции match] будет экземплярErr, содержащий подробности о том, какая ошибка случилась.
В зависимости от результата операции выполнится только одна ветка.
Так зачем же в этом коде .expect()?
File::open(filename).expect("error message");
Смотрю документацию по std::result::Result и вижу объяснение:
Разворачивает результат, возвращая содержимое
Ok. Паникует, если значение —Err, с сообщением о панике, включающим переданное сообщение и содержимоеErr.
То есть по сути .expect() — это сокращённая запись той самой конструкции match. Она либо достаёт результат, либо паникует с сообщением. Я заглянул в код std::result::Result и вижу вот что:
#[inline]
#[stable(feature = "result_expect", since = "1.4.0")]
pub fn expect(self, msg: &str) -> T {
match self {
Ok(t) => t,
Err(e) => unwrap_failed(msg, e),
}
}
Очень похоже на пример с сопоставлением Result, который я приводил выше.
И ещё одна цитата из Rust Book:
Rust делит ошибки на две большие категории: исправимые и неисправимые. В случае исправимой ошибки, например когда файл не найден, разумно сообщить о проблеме пользователю и повторить операцию. Неисправимые ошибки — это всегда симптомы багов, например попытка обратиться к элементу за пределами массива.
.expect() превращает исправимую ошибку в неисправимую. В простых случаях так обходиться с ситуацией нормально, но боевая программа не должна паниковать, если файла нет или его нельзя прочитать.
.unwrap() очень похож на .expect:
Разворачивает результат, возвращая содержимое
Ok. Паникует, если значение —Err, с сообщением о панике, которое берётся из значенияErr.
Так что отличие от expect только в том, что expect принимает дополнительное сообщение об ошибке.
Что почитать ещё:
- Rust Book: Error Handling
- Rust By Example: Result
- документация модуля std::result
- API std::result::Result