diff options
author | Giacomo Cavalieri <giacomo.cavalieri@icloud.com> | 2023-06-13 16:39:04 +0200 |
---|---|---|
committer | Louis Pilfold <louis@lpil.uk> | 2023-06-14 17:26:33 +0100 |
commit | 0449a9b9a120afc24a7cfdcbdc1eee023cf7cf11 (patch) | |
tree | b466d385a86ac8efae4bf0f7ccfdee4b6847d559 | |
parent | 46a898e3dd9419ab3123fedc11196a4a0abadf57 (diff) | |
download | gleam_stdlib-0449a9b9a120afc24a7cfdcbdc1eee023cf7cf11.tar.gz gleam_stdlib-0449a9b9a120afc24a7cfdcbdc1eee023cf7cf11.zip |
Rename `result.recover` to `result.try_recover`
-rw-r--r-- | CHANGELOG.md | 2 | ||||
-rw-r--r-- | src/gleam/result.gleam | 8 | ||||
-rw-r--r-- | test/gleam/result_test.gleam | 8 |
3 files changed, 9 insertions, 9 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 4671266..1bfd0cd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## Unreleased -- The `result` module gains the `recover` function. +- The `result` module gains the `try_recover` function. ## v0.29.1 - 2023-06-01 diff --git a/src/gleam/result.gleam b/src/gleam/result.gleam index 5207a66..d53b72b 100644 --- a/src/gleam/result.gleam +++ b/src/gleam/result.gleam @@ -458,21 +458,21 @@ pub fn values(results: List(Result(a, e))) -> List(a) { /// ## Examples /// /// ```gleam -/// > Ok(1) |> recover(with: fn(_) { Error("failed to recover") }) +/// > Ok(1) |> try_recover(with: fn(_) { Error("failed to recover") }) /// Ok(1) /// ``` /// /// ```gleam -/// > Error(1) |> recover(with: fn(error) { Ok(error + 1) }) +/// > Error(1) |> try_recover(with: fn(error) { Ok(error + 1) }) /// Ok(2) /// ``` /// /// ```gleam -/// > Error(1) |> recover(with: fn(error) { Error("failed to recover") }) +/// > Error(1) |> try_recover(with: fn(error) { Error("failed to recover") }) /// Error("failed to recover") /// ``` /// -pub fn recover( +pub fn try_recover( result: Result(a, e), with fun: fn(e) -> Result(a, f), ) -> Result(a, f) { diff --git a/test/gleam/result_test.gleam b/test/gleam/result_test.gleam index 53ef8c3..8e4c831 100644 --- a/test/gleam/result_test.gleam +++ b/test/gleam/result_test.gleam @@ -250,16 +250,16 @@ pub fn values_test() { |> should.equal([1, 3]) } -pub fn recover_test() { +pub fn try_recover_test() { Ok(1) - |> result.recover(fn(_) { panic }) + |> result.try_recover(fn(_) { panic }) |> should.equal(Ok(1)) Error(1) - |> result.recover(fn(n) { Ok(n + 1) }) + |> result.try_recover(fn(n) { Ok(n + 1) }) |> should.equal(Ok(2)) Error(1) - |> result.recover(fn(_) { Error("failed to recover") }) + |> result.try_recover(fn(_) { Error("failed to recover") }) |> should.equal(Error("failed to recover")) } |