Provide catching alternative to `AsyncResult.ofAsync`?

[njlr]

This code will throw an exception:

#r "nuget: FsToolkit.ErrorHandling, 5.2.0"

open FsToolkit.ErrorHandling

let workflow =
  async {
    failwith "kaboom"

    return 1
  }

asyncResult {
  let! x =
    workflow
    |> AsyncResult.ofAsync

  return x + 1
}
|> Async.RunSynchronously
|> printfn "%A"

But users might want to catch and print:

Error
  System.Exception: kaboom

The following behaves with catching behavior:

#r "nuget: FsToolkit.ErrorHandling, 5.2.0"

open FsToolkit.ErrorHandling

let workflow =
  async {
    failwith "kaboom"

    return 1
  }

asyncResult {
  let! x =
    workflow
    |> AsyncResult.ofAsync
    |> AsyncResult.catch id

  return x + 1
}
|> Async.RunSynchronously
|> printfn "%A"

Perhaps a catching helper should be provided?

[<RequireQualifiedAccess>]
module AsyncResult =

  let catchAsync (workflow : Async<'a>) : Async<Result<'a, exn>> =
    async {
      try
        let! res = workflow

        return Ok res
      with ex ->
        return Error ex
    }

This would be opposite of AsyncResult.getOrReraise.

Can send a PR. Thanks!

[njlr]

Given #353 perhaps name this AsyncResult.ofCatchAsync?

[bartelink]

FYI an incoming proposal for FSharp Core modules with common function names is to have a function named Async.catch yield Result<'T, exn> (while Async.Catch continues to yield Async<Choice<'T, exn>> for backcompat.

Given the signature matches and the Async in the name catchAsync is redundant maybe calling the helper catch' or something that conveys that it's basically the catch for AsyncResult - it's just that this lib has made catch imply something slightly different?

If that was in the box in FSharp.Core, you should be able to just do:

let workflow =
  async {
    failwith "kaboom"

    return 1
  }

asyncResult {
  let! x = workflow |> Async.catch
  return x + 1
}
|> Async.RunSynchronously
|> printfn "%A" // Result.Error (Exception "kaboom")