Flutter结果处理插件resultz的使用

Resultz Dart包为Dart和Flutter应用提供了一种简单且类型安全的方式来处理结果。它允许你将操作的结果表示为错误或成功，并提供了方便的方法来处理这些结果。

安装

要使用此包，请在你的pubspec.yaml文件中添加resultz作为依赖项：

dependencies:
  resultz: ^1.0.0 # 使用pub.dev上的最新版本

然后运行flutter pub get来获取包。

使用

创建和处理结果

结果被表示为Result<ERR, OK>，其中ERR是错误类型，OK是成功类型。你可以使用Err创建错误结果，使用Ok创建成功结果。

Future<Result<AddTaskError, Task>> addTask(Task task) async {
  try {
    
    if (task.title.isEmpty) {
        return Err(AddTaskError('Title cannot be empty'));
    }

    // 添加任务到数据库

    return Ok(task);
  } catch (e) {
    return Err(AddTaskError('Failed to add task'));
  }
}

检查结果类型

你可以使用isErr和isOk获取器来检查结果的类型：

if (result.isErr) {
  // 处理错误
} else if (result.isOk) {
  // 处理成功
}

访问值

要访问错误或成功的值，可以使用err和ok获取器。但是，建议在访问值之前检查结果的类型以确保类型安全。

if (result.isErr) {
    final error = result.err;
    // 处理错误
    return;
}

var okResult = result.ok;
// 处理成功

使用结果检查器

ResultChecker类提供了一种方便的方式根据结果类型来处理结果。你可以指定错误或成功类型，当使用ifErr和ifOk方法时，确保类型安全。

处理错误

使用ifErr方法来处理特定类型的错误：

result.check.ifErr<SpecificErrorType>((error) {
  // 处理特定类型的错误
});

处理成功

使用ifOk方法来处理特定类型的成功：

result.check.ifOk<SpecificSuccessType>((success) {
  // 处理特定类型的成功
});

处理未匹配的结果

elseDo方法允许你定义一个回调函数，当结果没有被任何前面的检查匹配时调用：

result.check
  ..ifErr<SpecificErrorType>((error) {
    // 处理特定错误
  })
  ..ifOk<SpecificSuccessType>((success) {
    // 处理特定成功
  })
  ..elseDo(() {
    // 处理未匹配的结果
  });

通过在ifErr和ifOk中指定类型，你可以确保处理正确的错误或成功类型，从而在代码中提供类型安全。

映射结果

你可以使用map和mapFuture方法来转换结果：

final transformedResult = result.map(
  onErr: (error) => Err<int, String>(error * 2),
  onOk: (success) => Ok<int, String>('Transformed $success'),
);

final transformedResultFuture = result.mapFuture(
  onErr: (error) async => Err<int, String>(error * 2),
  onOk: (success) async => Ok<int, String>('Transformed $success'),
);

确保处理错误

该包提供了一个ResultException类，如果你尝试在不检查结果类型的情况下访问值，则会抛出该异常。

try {
  final error = result.err; // 可能抛出ResultException
} catch (e) {
  print('Error: $e');
}

// err 获取器如果结果不是错误则抛出ResultException
ERR get err {
if (!isErr) {
    throw ResultException('Did not check isErr before getting err');
}

return (this as Err<ERR, OK>).val;
}