FsToolkit.ErrorHandling.TaskResult 4.16.0

FsToolkit.ErrorHandling

FsToolkit.ErrorHandling 是一个用于在 F# 中工作与 Result 类型的实用库，并允许您进行清晰、简单和强大的错误处理。

该库提供如 map、bind、apply、traverse、sequence 等辅助函数，以及用于操作 Result<'a, 'b>、Result<'a option, 'b>、Async<Result<'a, 'b>>、Async<Result<'a option, 'b>> 和 Result<'a, 'b list> 的计算表达式和前缀操作符。

它受到了 Chessie 和 Cvdm.ErrorHandling（后者现已被合并到 FsToolkit.ErrorHandling）的启发。

FsToolkit.ErrorHandling 靶向 .NET Standard 2.0 和 .NET Framework 4.6.1，并支持 Fable。

文档

文档在此处 提供。

其他资料

• 学习这种编程风格的主要资源是 面向铁路的编程
• 然而，Result 并非万能药，请参见其潜在陷阱和情况，您不应使用 Result。 为异常辩护：抛弃你的 Result

构建

GitHub Actions

NuGet

包名	发布	预发布
FsToolkit.ErrorHandling
FsToolkit.ErrorHandling.TaskResult
FsToolkit.ErrorHandling.JobResult
FsToolkit.ErrorHandling.AsyncSeq
FsToolkit.ErrorHandling.IcedTasks

本地开发

Devcontainer

本仓库为VSCode配置了devcontainer。更多详细信息请参见

• VSCode

本地设置

• .NET Core SDK
  • v6.x
  • v7.x

可选

为了在本地上测试fable构建，您需要

• Node
  • v18.0.0或更高版本
  • 不是必须的，但建议您使用NVM来轻松管理多个版本的Node
• Python
  • v3.10.0或更高版本
  • 适用于Fable-Python

编译

> build.cmd <optional buildtarget> // on windows
$ ./build.sh  <optional buildtarget>// on unix

未经指定构建目标，默认目标为DotnetPack，它将在dotnet上运行所有项目的测试，然后将项目打包成nuget包。有关其他显著的目标，请参阅以下内容。

构建目标

• Clean - 将清理所有项目的 bin 和 obj 文件夹
• DotnetTest - 将运行dotnet项目的测试
• NpmTest - 将运行fable-javascript项目的测试
• PythonTest - 将运行fable-python项目的测试
• RunTests - 将运行dotnet、fable-javascript和fable-python项目的测试
• FormatCode - 将运行 fantomas 对代码库进行格式化

这不是一个详尽无遗的列表。更多目标可以在 ./build/build.fs 文件中找到。

一个激励性的例子

此组合登录流程的示例展示了如何使用计算表达式和一些辅助函数，仅使用这个库就能实现清晰、简单、强大的错误处理。（该库还有许多其他辅助函数和计算表达式以及中缀操作符；有关详细信息，请参阅文档。）

// Given the following functions:
//   tryGetUser: string -> Async<User option>
//   isPwdValid: string -> User -> bool
//   authorize: User -> Async<Result<unit, AuthError>>
//   createAuthToken: User -> Result<AuthToken, TokenError>

type LoginError = InvalidUser | InvalidPwd | Unauthorized of AuthError | TokenErr of TokenError

let login (username: string) (password: string) : Async<Result<AuthToken, LoginError>> =
  asyncResult {
    // requireSome unwraps a Some value or gives the specified error if None
    let! user = username |> tryGetUser |> AsyncResult.requireSome InvalidUser

    // requireTrue gives the specified error if false
    do! user |> isPwdValid password |> Result.requireTrue InvalidPwd

    // Error value is wrapped/transformed (Unauthorized has signature AuthError -> LoginError)
    do! user |> authorize |> AsyncResult.mapError Unauthorized

    // Same as above, but synchronous, so we use the built-in mapError
    return! user |> createAuthToken |> Result.mapError TokenErr
  }

赞助商

<a href="https://www.ajira.tech"><img src="./Ajira-logo.png" alt="Ajira Technologies, India" width="200" /></a>