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