-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7bad77c
commit 2807702
Showing
33 changed files
with
817 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # AsyncResult.ofAsync | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Transforms a `Async<'T>` into an `Async<Result<'T, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Async<'T> -> Async<Result<'T, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofAsync (async { return 42 }) | ||
| // async { return Ok 42 } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # AsyncResult.ofResult | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Transforms a `Result<'T, 'Error>` into an `Async<Result<'T, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Result<'T, 'Error> -> Async<Result<'T, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofResult (Ok 42) | ||
| // async { return Ok 42 } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofResult (Error "Boom!") | ||
| // async { return Error "Boom!" } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,27 @@ | ||
| ## AsyncResult.ofTask | ||
| # AsyncResult.ofTask | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Function Signature: | ||
| Transforms a `Task<'T>` into an `Async<Result<'T, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Task<'a> -> Async<Result<'a, Exception>> | ||
| Task<'T> -> Async<Result<'T, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofTask (Task.FromResult 42) | ||
| // async { return Ok 42 } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofTask (Task.FromException (System.Exception("Boom!"))) | ||
| // async { return Error (System.Exception("Boom!")) } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,27 @@ | ||
| ## AsyncResult.ofTaskAction | ||
| # AsyncResult.ofTaskAction | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Function Signature: | ||
| Transforms a `Task` into an `Async<Result<unit, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Task -> Async<Result<unit, Exception>> | ||
| Task -> Async<Result<unit, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofTaskAction (Task.Delay 1000) | ||
| // async { do () } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofTaskAction (Task.FromException (System.Exception("Boom!"))) | ||
| // async { return Error (System.Exception("Boom!")) } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # AsyncResultOption.ofAsyncOption | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Transforms a `Async<'T option>` into an `Async<Result<'T option, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Async<'T option> -> Async<Result<'T option, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResultOption.ofAsyncOption (async { return Some 42 }) | ||
| // async { return Ok (Some 42) } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResultOption.ofAsyncOption (async { return None }) | ||
| // async { return Ok None } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # AsyncResultOption.ofAsyncResult | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Transforms a `Async<Result<'T, 'Error>>` into an `Async<Result<'T option, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| Async<Result<'T, 'Error>> -> Async<Result<'T option, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofAsyncResult (async { return Ok 42 }) | ||
| // async { return Ok (Some 42) } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResult.ofAsyncResult (async { return Error "error" }) | ||
| // async { return Error "error" } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # AsyncResultOption.ofOption | ||
|
|
||
| Namespace: `FsToolkit.ErrorHandling` | ||
|
|
||
| Transforms a `'T option` into an `Async<Result<'T option, 'Error>>`. | ||
|
|
||
| ## Function Signature | ||
|
|
||
| ```fsharp | ||
| 'T option -> Async<Result<'T option, 'Error>> | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResultOption.ofOption (Some 42) | ||
| // async { return Ok (Some 42) } | ||
| ``` | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```fsharp | ||
| let result = AsyncResultOption.ofOption None | ||
| // async { return Ok None } | ||
| ``` |
Oops, something went wrong.