mo - Monads

🦄 samber/mo 为 Go 项目带来了单子和流行的函数式编程抽象。samber/mo 使用了最新的 Go 1.18+ 泛型。

灵感来源：

• Scala
• Rust
• FP-TS

另请参阅：

• samber/lo：基于 Go 1.18+ 泛型的 Lodash 风格 Go 库
• samber/do：基于 Go 1.18+ 泛型的依赖注入工具包

为什么选择这个名字？

我喜欢这种实用库使用简短的名称。这个名字类似于 "Monad Go"，而且没有 Go 包使用这个名称。

💡 特性

我们目前支持以下数据类型：

• Option[T]（Maybe）
• Result[T]
• Either[A, B]
• EitherX[T1, ..., TX]（X 在 3 到 5 之间）
• Future[T]
• IO[T]
• IOEither[T]
• Task[T]
• TaskEither[T]
• State[S, A]

🚀 安装

go get github.com/samber/mo@v1

这个库是 v1 版本，严格遵循语义化版本控制。

在 v2.0.0 版本之前，不会对导出的 API 进行破坏性更改。

这个库除了 Go 标准库外没有其他依赖。

💡 快速开始

你可以使用以下方式导入 mo：

import (
    "github.com/samber/mo"
)

然后使用以下帮助函数：

option1 := mo.Some(42)
// Some(42)

option1.
    FlatMap(func (value int) Option[int] {
        return Some(value*2)
    }).
    FlatMap(func (value int) Option[int] {
        return Some(value%2)
    }).
    FlatMap(func (value int) Option[int] {
        return Some(value+21)
    }).
    OrElse(1234)
// 21

option2 := mo.None[int]()
// None

option2.OrElse(1234)
// 1234

option3 := option1.Match(
    func(i int) (int, bool) {
        // 当值存在时
        return i * 2, true
    },
    func() (int, bool) {
        // 当值不存在时
        return 0, false
    },
)
// Some(42)

更多示例请查看文档。

给懒惰开发者的建议

我不推荐这样做，但如果你懒得到处重复 mo.，你可以将整个库导入到命名空间中。

import (
    . "github.com/samber/mo"
)

我对这种垃圾做法不负任何责任。😁 💩

🤠 文档和示例

GoDoc: https://godoc.org/github.com/samber/mo

Option[T any]

Option 是一个包含可选值 T 的容器。如果值存在，Option 的类型为 Some。如果值不存在，Option 的类型为 None。

实现：

• mo.Foldable[T, U]

构造函数：

• mo.Some() 文档 - 演示
• mo.None() 文档 - 演示
• mo.TupleToOption() 文档 - 演示
• mo.EmptyableToOption() 文档 - 演示
• mo.PointerToOption() 文档 - 演示

方法：

• .IsPresent() 文档 - 演示
• .IsAbsent() 文档 - 演示
• .Size() 文档 - 演示
• .Get() 文档 - 演示
• .MustGet() 文档 - 演示
• .OrElse() 文档 - 演示
• .OrEmpty() 文档 - 演示
• .ToPointer() 文档 - 演示
• .ForEach() 文档
• .Match() 文档 - 演示
• .Map() 文档 - 演示
• .MapNone() 文档 - 演示
• .FlatMap() 文档 - 演示
• .MarshalJSON() 文档
• .UnmarshalJSON() 文档
• .MarshalText() 文档
• .UnmarshalText() 文档
• .MarshalBinary() 文档
• .UnmarshalBinary() 文档
• .GobEncode() 文档
• .GobDecode() 文档
• .Scan() 文档
• .Value() 文档

其他：

• mo.Fold[T, U, R any](f Foldable[T, U], successFunc func(U) R, failureFunc func(T) R) R 文档

Result[T any]

Result 表示一个操作的结果，可能有以下两种输出之一：成功或失败。Result 的实例要么是 Ok 类型，要么是 Err 类型。它可以与 Either[error, T] 进行比较。

实现：

• mo.Foldable[T, U]

构造函数：

• mo.Ok() 文档 - 演示
• mo.Err() 文档 - 演示
• mo.Errf() 文档 - 演示
• mo.TupleToResult() 文档 - 演示
• mo.Try() 文档 - 演示

方法：

• .IsOk() 文档 - 演示
• .IsError() 文档 - 演示
• .Error() 文档 - 演示
• .Get() 文档 - 演示
• .MustGet() 文档 - 演示
• .OrElse() 文档 - 演示
• .OrEmpty() 文档 - 演示
• .ToEither() 文档 - 演示
• .ForEach() 文档
• .Match() 文档 - 演示
• .Map() 文档 - 演示
• .MapErr() 文档 - 演示
• .FlatMap() 文档 - 演示

其他：

• mo.Fold[T, U, R any](f Foldable[T, U], successFunc func(U) R, failureFunc func(T) R) R 文档
• mo.Do[T any](fn func() T) (result mo.Result[T]) 文档

Either[L any, R any]

Either 表示两种可能类型的值。Either 的实例是 A 或 B 的实例。

实现：

• mo.Foldable[T, U]

构造函数：

• mo.Left() 文档
• mo.Right() 文档

方法：

• .IsLeft() 文档
• .IsRight() 文档
• .Left() 文档
• .Right() 文档
• .MustLeft() 文档
• .MustRight() 文档
• .Unpack() 文档
• .LeftOrElse() 文档
• .RightOrElse() 文档
• .LeftOrEmpty() 文档
• .RightOrEmpty() 文档
• .Swap() 文档
• .ForEach() 文档
• .Match() 文档
• .MapLeft() 文档
• .MapRight() 文档

其他：

• mo.Fold[T, U, R any](f Foldable[T, U], successFunc func(U) R, failureFunc func(T) R) R 文档

EitherX[T1, ..., TX] (X 在 3 到 5 之间)

EitherX 表示 X 种可能类型的值。例如，Either3 值要么是 T1，要么是 T2，要么是 T3。

构造函数：

• mo.NewEitherXArgY() 文档。例如：
  • mo.NewEither3Arg1[A, B, C](A)
  • mo.NewEither3Arg2[A, B, C](B)
  • mo.NewEither3Arg3[A, B, C](C)
  • mo.NewEither4Arg1[A, B, C, D](A)
  • mo.NewEither4Arg2[A, B, C, D](B)
  • ...

方法：

• .IsArgX() 文档
• .ArgX() 文档
• .MustArgX() 文档
• .Unpack() 文档
• .ArgXOrElse() 文档
• .ArgXOrEmpty() 文档
• .ForEach() 文档
• .Match() 文档
• .MapArgX() 文档

Future[T any]

Future 表示一个可能当前不可用但将来某个时刻会可用的值，或者如果该值无法获得时的异常。

构造函数：

• mo.NewFuture() 文档

方法：

• .Then() 文档
• .Catch() 文档
• .Finally() 文档
• .Collect() 文档
• .Result() 文档
• .Cancel() 文档

IO[T any]

IO 表示一个可能产生副作用的非确定性同步计算，它产生 R 类型的值且永不失败。

构造函数：

• mo.NewIO() 文档
• mo.NewIO1() 文档
• mo.NewIO2() 文档
• mo.NewIO3() 文档
• mo.NewIO4() 文档
• mo.NewIO5() 文档

方法：

• .Run() 文档

IOEither[T any]

IO 表示一个可能产生副作用的非确定性同步计算，它产生 R 类型的值且可能失败。

构造函数：

• mo.NewIOEither() 文档
• mo.NewIOEither1() 文档
• mo.NewIOEither2() 文档
• mo.NewIOEither3() 文档
• mo.NewIOEither4() 文档
• mo.NewIOEither5() 文档

方法：

• .Run() 文档

Task[T any]

Task 表示一个可能产生副作用的非确定性异步计算，它产生 R 类型的值且永不失败。

构造函数：

• mo.NewTask() 文档
• mo.NewTask1() 文档
• mo.NewTask2() 文档
• mo.NewTask3() 文档
• mo.NewTask4() 文档
• mo.NewTask5() 文档
• mo.NewTaskFromIO() 文档
• mo.NewTaskFromIO1() 文档
• mo.NewTaskFromIO2() 文档
• mo.NewTaskFromIO3() 文档
• mo.NewTaskFromIO4() 文档
• mo.NewTaskFromIO5() 文档

方法：

• .Run() 文档

TaskEither[T any]

TaskEither 表示一个可能产生副作用的非确定性异步计算，它产生类型为 R 的值，并且可能失败。

构造函数：

• mo.NewTaskEither() 文档
• mo.NewTaskEitherFromIOEither() 文档

方法：

• .Run() 文档
• .OrElse() 文档
• .Match() 文档
• .TryCatch() 文档
• .ToTask() 文档
• .ToEither() 文档

State[S any, A any]

State 表示一个函数 (S) -> (A, S)，其中 S 是状态，A 是结果。

构造函数：

• mo.NewState() 文档
• mo.ReturnState() 文档

方法：

• .Run() 文档
• .Get() 文档
• .Modify() 文档
• .Put() 文档

Foldable[T, U]

Foldable 表示一种可以根据其状态折叠成单一值的类型。

• mo.Fold[T, U, R any](f Foldable[T, U], successFunc func(U) R, failureFunc func(T) R) R 文档

🛩 基准测试

// @TODO

这个库不使用 reflect 包。我们不期望有额外开销。

🤝 贡献

• 在 Twitter 上联系我 @samuelberthe（私信、提及，随意 :)）
• Fork 项目
• 修复 open issues 或请求新功能

不要犹豫 ;)

使用 Docker

docker-compose run --rm dev

不使用 Docker

# 安装一些开发依赖
make tools

# 运行测试
make test
# 或
make watch-test

👤 贡献者

💫 表示支持

如果这个项目对你有帮助，请给一个 ⭐️！

📝 许可证

版权所有 © 2022 Samuel Berthe。

本项目采用 MIT 许可证。