FsToolkit.ErrorHandling.JobResult 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>